Tôi biết cách tiêu chuẩn để tài liệu chức năng, các lớp học và các mô-đun là gì, nhưng làm thế nào để tài liệu gói - tôi đặt một docstring trong __init__.py, hoặc cái gì khác?làm thế nào để tài liệu một gói python
Vâng, giống như cho một chức năng hoặc nhận xét về lớp, mục đầu tiên trong file __init__.py phải là một chuỗi bình luận:
"""
This is the xyz package.
"""
Bây giờ nếu bạn nhập gói, và sử dụng sự giúp đỡ (gói), bạn sẽ thấy chuỗi tài liệu của mình. Xem thêm ở đây: http://www.python.org/dev/peps/pep-0257/
Xem PEP257
Một gói có thể được ghi lại trong các mô-đun docstring của tập tin __.py __ init trong thư mục gói.
tư liệu là một ý tưởng tốt, miễn là bạn không ghi lại một cái gì đó rõ ràng trong mã của bạn
Cố gắng hiểu rằng hầu hết mọi người đọc nguồn của bạn sẽ hiểu python, vì vậy cho ý kiến hoặc ghi lại dòng như thế này là vô nghĩa:
a = 1 #this assigns 1 to a
Nhưng việc nhận xét hoặc ghi lại một hàm hoặc lớp khá phức tạp là một ý tưởng hay.
Quy tắc chung của ngón tay cái: Hãy tưởng tượng người tiếp theo làm việc trên mã của bạn là Axe có khả năng gây hận và họ biết bạn sống ở đâu.
Bằng cách đó, bạn sẽ luôn để lại nhận xét "hữu ích"/tài liệu