PEP 257 says:Tôi có thể tìm thấy các ví dụ phù hợp về quy ước PEP 257 Docstringions ở đâu?
Chèn một dòng trống trước và sau khi tất cả docstrings (một dòng hoặc đa dòng) mà tài liệu một lớp - nói chung, phương pháp của lớp được tách ra khỏi nhau bằng một đơn dòng trống, và các docstring cần phải được bù đắp từ phương pháp đầu tiên bởi một dòng trống; để đối xứng, đặt một dòng trống giữa tiêu đề lớp và docstring.
Nhưng dường như tôi không thể tìm thấy bất kỳ mã nào thực sự thực hiện việc này.
Tôi đã kiểm tra một số mô-đun tiêu chuẩn được phân phối bằng Python 2.6, thậm chí đã tìm kiếm cụ thể cho các mô-đun mà tên của Guido được đề cập. Nhưng ngay cả các mã của các công cụ xem xét mã Rietveld không IMHO không tuân thủ (xem ví dụ http://code.google.com/p/rietveld/source/browse/upload.py):
class CondensedHelpFormatter(optparse.IndentedHelpFormatter):
"""Frees more horizontal space by removing indentation from group
options and collapsing arguments between short and long, e.g.
'-o ARG, --opt=ARG' to -o --opt ARG"""
def format_heading(self, heading):
return "%s:\n" % heading
dòng docstring đa này không có một dòng trống ở trước và dòng trống sau là bên ngoài các dấu ngoặc kép đóng cửa .
Lớp này từ /usr/lib64/python2.6/site.py không có dòng trống trước nhưng có dòng trống trước và sau dấu ngoặc kép.
class _Helper(object):
"""Define the built-in 'help'.
This is a wrapper around pydoc.help (with a twist).
"""
def __repr__(self):
Có ví dụ nào để chứng minh PEP 257 không?
Cảm ơn trước
" Danh sách "/" Thăm dò ý kiến "không phải là chủ đề cho Stack Overflow. Ngoài ra, tôi không thấy làm thế nào điều này liên quan đến một vấn đề thực sự bạn đang cố gắng để giải quyết. – agf
Tôi đánh giá cao nghiên cứu bạn đã thực hiện và chắc chắn các ví dụ có thể được tìm thấy ở định dạng docstring chính thức, nhưng nó không thực sự rõ ràng về những lợi ích sẽ cung cấp. Có những ví dụ ngoài những tài liệu không chính xác, một số trong số đó có lẽ được viết bởi Guido. Nếu bạn muốn viết chính xác, chỉ cần làm theo các hướng dẫn (bản thân tài liệu PEP thậm chí đưa ra các ví dụ). Tóm lại, điểm ở đây là gì? Tại sao chính xác bạn cần (nhiều hơn) ví dụ về định dạng này? –
@agf: đây không phải là cuộc thăm dò ý kiến. Tôi tin rằng PEP không rõ ràng 100% ở một số khu vực và tôi đang tìm kiếm các ví dụ làm rõ các phần đó. Cụ thể tôi đang lokking cho một ví dụ về docstrings cho một lớp học phù hợp với PEP. Mã của halst hiển thị các dòng trống trước và sau chuỗi tài liệu lớp cũng như dòng trống ở cuối chính chuỗi tài liệu. Đó là một lựa chọn khác mà tôi chưa từng cân nhắc. – Bram