데이터에 대한 문서화?

Question

DocString이 모듈이나 funcion을 설명하는 것과 유사한 방식으로 모듈의 데이터를 설명하는 방법이 있습니까?

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

Answer 1

내가 아는 한, docstrings를 모듈 데이터 멤버에 할당 할 수는 없습니다.

PEP 224 이 기능을 제안하지만 PEP는 거부되었습니다.

모듈의 docString에 모듈의 데이터 구성원을 문서화하는 것이 좋습니다.

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

module.data: contains the word "spam"

"""

data = "spam"

Answer 2

그것 ~이다 사용하여 모듈의 데이터를 문서화 할 수 있습니다. epydoc 통사론. epydoc은 파이썬에 가장 자주 사용되는 문서 도구 중 하나입니다.

문서화의 구문은입니다 #: 이와 같은 변수 초기화 라인을 넘어서

# module.py:

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

이제 문서를 생성하면 data 주어진 설명 및 유형이있는 모듈 변수로 설명됩니다. str. 당신은 생략 할 수 있습니다 @type 선.

Answer 3

Codeape가 설명했듯이 일반 데이터 구성원을 문서화 할 수는 없습니다.

그러나, 그것은 ~이다 문서화 할 수 있습니다 property 데이터 구성원 :

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''')

이것은 docstring을 줄 것입니다 foo 분명히 속성.