【Python3.x】__doc__定数の使い方
__doc__定数の使い方について、初心者にもわかりやすく解説します。
作成日: 更新日:
基本的な使い方
__doc__定数は、Pythonの様々なオブジェクトに付随するドキュメンテーション文字列(docstring)を表す定数です。この__doc__属性は、モジュール、クラス、関数、メソッド、プロパティなどの定義の直後に記述された、プログラムの目的や使い方を説明するための文字列を保持します。
__doc__に格納されるドキュメンテーション文字列は、開発者がコードを理解しやすくするために非常に重要です。例えば、Pythonの組み込み関数であるhelp()を使ってオブジェクトの情報を参照する際や、統合開発環境(IDE)がコード補完やツールチップでオブジェクトの概要を表示する際に、この__doc__属性にアクセスしてその内容を利用します。
この定数自体は、各オブジェクトに自動的に割り当てられる特殊な属性であり、開発者が明示的に定義するものではなく、オブジェクト定義直後の文字列リテラルがPythonインタープリタによって自動的に__doc__に設定されます。これにより、コードの自己文書化を促進し、他の開発者や将来の自分自身がコードの意図を素早く把握できるよう支援する、Pythonの強力な機能の一つです。
構文(syntax)
1print(str.__doc__)
引数(parameters)
引数なし
引数はありません
戻り値(return)
str | None
__doc__ は、そのオブジェクト(モジュール、クラス、関数、メソッドなど)のドキュメンテーション文字列を返します。ドキュメンテーション文字列がない場合は None を返します。