関数のヘッダ部分に,コメント文形式でその関数の仕様(Docstring)を書いておくとhelp()
で参照したり出来る。
書くべき内容についてはPEPで決められていて,PEP 257 – Docstring Conventionsに詳細の説明がある。
以下は,このPEPのページからのメモ。
def function(x):
"""Do something difficult and return a list."""
if something: print("hello")
...
以下のように,関数の定義をそのまま書き直すようなのはダメ。
def function(x):
"""function(x) -> list"""
...
-h
をつけて実行したときや,引数が足りない時などに表示するusage(使い方)に相当する内容__init__.py
のdocstring)では,パッケージ内のモジュール,サブパッケージの概要を書く__init__
メソッドのdocstringで文書化具体的な書き方には,いくつかお流儀がある。 以下は,Googleスタイルでの例。Google Styleのいろいろな例はExample Google Style Python Docstringsを参照。
def example_function(param1, param2):
"""Example function with types documented in the docstring.
Args:
param1 (int): The first parameter.
param2 (int): The second parameter.
Returns:
int: Sum of param1 and param2.
Examples:
Examples should be written in doctest format, and should illustrate how
to use the function.
>>> example_function(4, 5)])
9
"""
return param1 + param2
ソースコード中のdocstringを抽出してmarkdownにするスクリプトがいろいろある。 どれが良いかは不明。。。