データのドキュメント文字列？

StackOverflow https://stackoverflow.com/questions/197387

  •  10-07-2019
  •  | 
  •  

質問

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

class MyClass(object):
    def my_function():
        """This docstring works!"""
        return True
    my_list = []
    """This docstring does not work!"""
役に立ちましたか？

解決

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

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

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

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

module.data: contains the word "spam"

"""

data = "spam"

他のヒント

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

文書化の構文は、次のように変数初期化行の上にある＃：です。

# module.py:

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

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

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が渡されます。明らかに

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top