Webエンジニア向けプログラミング解説動画をYouTubeで配信中!
▶ チャンネル登録はこちら

【Python3.x】__loader__::__doc__定数の使い方

__doc__定数の使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

__doc__定数は、Pythonのモジュール、クラス、関数、メソッドといった様々なオブジェクトに付随する「ドキュメンテーション文字列」を表す定数です。この__doc__は、そのオブジェクトが何であるか、どのような機能を持つか、どのように使用するべきかといった説明を記述するために使用されます。開発者は、対象となるオブジェクトの直下に三重引用符(トリプルクォート)で囲まれた文字列を記述することで、このドキュメンテーション文字列を設定します。

この情報は、コードの可読性と保守性を飛躍的に向上させるための重要な要素です。例えば、Pythonの対話型インタープリタでhelp()関数にオブジェクトを渡すと、この__doc__に格納された内容が表示され、そのオブジェクトの使い方を素早く確認できます。また、多くの統合開発環境(IDE)では、関数やクラスのツールチップとして__doc__の内容が表示され、開発者がコードを理解し、適切に利用する手助けとなります。

システムエンジニアを目指す方にとって、他者の書いたコードを理解したり、自身が作成したコードを後から見返したり、あるいは他の開発者と共同で作業したりする際に、__doc__は非常に役立ちます。コードの意図を明確に伝えるための標準的な手段として、積極的に活用することが推奨されます。

構文(syntax)

1print(__loader__.__doc__)

引数(parameters)

引数なし

引数はありません

戻り値(return)

str | None

この属性は、モジュールのドキュメンテーション文字列を文字列型で返します。ドキュメンテーション文字列が存在しない場合はNoneを返します。

関連コンテンツ

関連プログラミング言語