doc string を使えば、Python の関数を文書化できる。
Example 2.2. Defining the buildConnectionString Function's doc string
def buildConnectionString(params):
"""Build a connection string from a dictionary of parameters.
Returns string."""
トリプルクウォートが複数行のストリングを可能にする。開始と終わりのクウォート中にあるすべては、単一ストリングの一部で、改行やその他のクウォート文字も含む。この機能を、どこでも使うことができるが、一番良く見かけるのは、doc string を定義する時であろう。
トリプルクウォートは、Perl における qq/.../ の様な感じで、シングルおよびダブルクウォートを使って、ストリングを定義する簡易な方法でもある。
トリプルクウォート間のすべては関数の doc string で、関数が何をするかを文書化する。 doc string を書く場合、関数で定義される最初のものでなくてはならない(つまり、コロン後の最初のもの)。技術的には関数に doc string を与える必要はないが、書くべきだ。こういったことは、どんなプログラミングの授業でも聞くが、Python では、そうすることにインセンティブがある。doc string は実行時に、関数の属性として、利用可能なのだ。
多くの Python IDE は doc string を使って、文脈に応じた文書を提供する。関数名をタイプすると、ツールチップとして、その doc string が現れる。これは非常に便利だが、それは書かれた doc string の品質による。
Further Reading on Documenting Functions(文書化関数に関する文献リスト)
PEP 257 は、doc string を規定している。
Python Style Guide は、良い doc string の書き方を話題にしている。
Python Tutorial は、doc string における スペーシング を話題にしている。