Pythonチュートリアル 4章 制御構造ツール(11)

ドキュメンテーション文字列

ドキュメンテーション文字列（docstring）とは、関数やクラスに対する説明文のことです。
実行時には無視されるもののコンパイラには認識され、クラス、関数、モジュールの__doc__属性に入ります。
“”” で始まり “”” で終わる様にします。
1行目は、大文字で始まりピリオドで終わります。
2行目は、空行にします。
つづく行は一つまたはそれ以上の段落で、対象物の呼び出し規約や副作用について記述します。

まとめ

今回は、ドキュメンテーション文字列（docstring）について説明しました。
次回は、関数のアノテーションについて説明します。