python - データのDocstring?

Question

docstring がモジュールまたは関数を記述するのと同様の方法で、モジュールのデータを記述する方法はありますか?

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

Answer 1

私の知る限り、docstring をモジュール データ メンバーに割り当てることはできません。

PEP 224はこの機能を提案していますが、PEP は拒否されました。

モジュールの docstring でモジュールのデータ メンバーを文書化することをお勧めします。

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

module.data: contains the word "spam"

"""

data = "spam"

Answer 2

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

fooこれは明らかに、属性にdocstring を与えます。

Answer 3

epydoc構文を使用して、モジュールのデータのドキュメントを作成することができます。Epydoc は、Python で最も頻繁に使用されるドキュメント ツールの 1 つです。

ドキュメントの構文は#:、次のように、変数の初期化行の上にあります。

# module.py:

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

ドキュメントを生成するdataと、指定された description と type を持つモジュール変数として記述されますstr。行を省略できます@type。