python - Pythonでモジュールを文書化するにはどうすればよいですか？

Question

それでおしまい。関数またはクラスを文書化する場合は、定義の直後に文字列を配置します。例えば：

def foo():
    """This function does nothing."""
    pass

しかし、モジュールはどうですか？file.pyの機能を文書化するにはどうすればよいですか？

Answer 1

モジュールの最初のステートメントとして docstring を追加します。

"""
Your module's verbose yet thorough docstring.
"""

import foo

# ...

パッケージの場合、docstring を に追加できます__init__.py。

Answer 2

パッケージについては、で文書化できます__init__.py。モジュールの場合、モジュールファイルにdocstringを追加するだけです。

すべての情報はここにあります：http ：//www.python.org/dev/peps/pep-0257/

Answer 3

あなたはそれをまったく同じ方法で行います。モジュールの最初のステートメントとして文字列を入力します。

Answer 4

簡単です。モジュールの上部にdocstringを追加するだけです。