1. ホーム
  2. python

Pythonでモジュールを文書化するには?

2023-08-17 02:15:18

質問

これで終わりです。関数やクラスをドキュメント化したい場合は、定義の直後に文字列を記述します。例えば

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

しかし、モジュールの場合はどうでしょうか?どのようにすれば ファイル.py は何をするのか?

どのように解決するのですか?

パッケージの場合は、ドキュメントを __init__.py . モジュールの場合は、モジュールファイル内に docstring を追加するだけです。

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