Pythonの組み込み属性「__doc__」とは？docstringの仕組みと使い方を解説

Pythonの__doc__属性とは

Pythonでは、すべての関数・クラス・モジュールが、組み込みの__doc__属性を持っています。この属性は、ソースコード内で定義されたドキュメンテーション文字列（docstring）を返します。

docstringとは、関数やクラスの定義直後に三重引用符（""" または '''）で囲んで記述する文字列のことです。その関数の目的や使い方、引数、戻り値など、開発者にとって有用な情報を記録するために使われます。

__doc__属性の基本的な使い方

以下の例では、関数fooにdocstringを定義し、__doc__属性を使ってその内容を取得しています。

def foo():
    """ This is an example of how a doc_string looks like.
            This string gives useful information about the function being defined.
    """
    pass

print(foo.__doc__)

このコードを実行すると、次のようにdocstringの内容が出力されます。

This is an example of how a doc_string looks like.
            This string gives useful information about the function being defined.

補足：help()関数との関係

組み込みのhelp()関数も、内部では__doc__属性を利用しています。対話シェルでhelp(foo)と入力すれば、整形された読みやすい形式でdocstringの内容を確認できます。

また、Python 3ではprintは関数として呼び出す必要があるため、上の例のようにprint(foo.__doc__)と括弧を付けて記述することに注意してください。