Docstring Conventions
*Trình bày:- Có thể dùng 4 dấu cách hoặc dấu tabs để thể hiện cấp của các khối lệnh. Chỉ dùng 1 trong 2 cách trên, k dùng đồng thời cả 2 cách.- Phân cách giữa các định nghĩa class và hàm đầu tiên là 2 dòng trống, giữa các phương thức trong class, hoặc giữa các hàm bằng 1 dòng trống- Các câu lệnh import dc tách thành từng dòng riêng biệt:VD: import a import bk viết: import a, b*Chú thích, tài liệu:- Cần có chú thích, giải thích đoạn mã phức tạp. Chú thích trong python sử dụng # coment trên 1 dòng: VD: # chu thich tren 1 dong- Cần có tài liệu giải thích(Documentation Strings) ở đầu mỗi chương trình, hàm, class về chức năng, cách sử dụng,…. Chúng được viết ở đầu chương trình, hàm, class là đặt trong 3 dấu nháy kép: “””<doc>”””. VD “””vi du ve Documentation Strings”””*Đặt tên hàm, biến:- Quy tắc quan trọng:+ 1 tên biến chỉ chứa số, kí tự, và dấu ‘_’.+ 1 tên biến k dc bắt đầu bằng số- Tiêu chí: + Tên cần thể hiện đầy đủ ý nghĩa của biến +Thông thường trong các ngôn ngữ, tên hàm và biến chữ cái đầu viết thường , các từ trong tên biến phân cách bằng viết hoa chữ cái đầu từ hoặc dấu ‘_’+ Có thể dùng các biến i, j, k, …. trong các vòng lặp, truy suất mản,…+ Các chữ cái trong tên hằng đều dc viết hoaVD: CONSTTham khảo chi tiết: http://www.python.org/dev/peps/pep-0008/
Bạn đang đọc truyện trên: RoTruyen.Com