Tài liệu cho dữ liệu?

Question

Có cách nào để mô tả dữ liệu của mô-đun theo cách tương tự như một docstring mô tả một mô-đun hoặc một funcion?

class MyClass(object): 
    def my_function(): 
     """This docstring works!""" 
     return True 
    my_list = [] 
    """This docstring does not work!""" 

Answer 1

Theo hiểu biết của tôi, không thể gán tài liệu cho thành viên dữ liệu mô-đun.

PEP 224 đề xuất tính năng này, nhưng PEP bị từ chối.

tôi đề nghị bạn ghi lại các thành viên dữ liệu của một mô-đun trong docstring của mô-đun:

# module.py: 
"""About the module. 

module.data: contains the word "spam" 

""" 

data = "spam" 

Answer 2

Nó là thể làm cho tài liệu dữ liệu mô-đun của, với việc sử dụng epydoc cú pháp. Epydoc là một trong những công cụ tài liệu được sử dụng thường xuyên nhất cho Python.

Cú pháp cho chủ tài liệu là #: trên đường khởi biến, như thế này:

# module.py: 

#: Very important data. 
#: Use with caution. 
#: @type: C{str} 
data = "important data" 

Bây giờ khi bạn tạo tài liệu của bạn, data sẽ được mô tả như mô-đun biến với mô tả nhất định và gõ str. Bạn có thể bỏ qua dòng @type.

Answer 3

Vì mã hóa giải thích, không thể ghi lại thành viên dữ liệu chung.

Tuy nhiên, nó là thể ghi lại property thành viên dữ liệu:

class Foo: 
    def get_foo(self): ... 

    def set_foo(self, val): ... 

    def del_foo(self): ... 

    foo = property(get_foo, set_foo, del_foo, '''Doc string here''') 

này sẽ cung cấp một docstring vào thuộc tính foo, rõ ràng.