docstringによるドキュメント定義

入門Python3 4.7.6

関数定義直後に文字列を定義することでその関数に対するドキュメントを定義することができます。

定義されたドキュメントはhelp関数でを使うことで整形されたドキュメントにして出力されます。

def foo(a):
    'ただ与えられた引数を表示するだけのものです。'
    print(a)

help(foo);

$ py main.py
Help on function foo in module __main__:

foo(a)
    ただ与えられた引数を表示するだけのものです。

整形前の素のドキュメント得るには以下のようにします。

def foo(a):
    'ただ与えられた引数を表示するだけのものです。'
    print(a)

print(foo.__doc__);

$ py main.py
ただ与えられた引数を表示するだけのものです。

なかなか便利な機能ですね。