Bài 9.6. Python - Quy tắc định dạng lớp

Một số vấn đề về định dạng liên quan đến các lớp đáng được làm rõ, đặc biệt khi các chương trình của bạn trở nên phức tạp hơn.

Tên lớp nên được viết theo kiểu CamelCase. Để làm điều này, viết hoa chữ cái đầu tiên của mỗi từ trong tên và không sử dụng dấu gạch dưới. Tên thể hiện và module nên được viết bằng chữ thường, với dấu gạch dưới giữa các từ.

Mỗi lớp nên có một docstring ngay sau định nghĩa lớp. Docstring nên là một mô tả ngắn gọn về những gì lớp làm, và bạn nên tuân theo các quy ước định dạng giống như khi viết docstring cho các hàm. Mỗi module cũng nên có một docstring mô tả các lớp trong module có thể được sử dụng để làm gì.

Bạn có thể sử dụng các dòng trống để tổ chức mã, nhưng đừng sử dụng chúng quá mức. Trong một lớp, bạn có thể sử dụng một dòng trống giữa các phương thức, và trong một module, bạn có thể sử dụng hai dòng trống để tách các lớp.

Nếu bạn cần nhập một module từ thư viện chuẩn và một module mà bạn đã viết, đặt lệnh nhập cho module thư viện chuẩn trước. Sau đó thêm một dòng trống và lệnh nhập cho module bạn đã viết. Trong các chương trình có nhiều lệnh nhập, quy ước này giúp dễ dàng nhìn thấy các module khác nhau được sử dụng trong chương trình đến từ đâu.

Comments

There are no comments at the moment.