［Python入門］docstringの書き方

［Python入門］docstringの書き方

docstringとは
　本連載の第5回「文字列の基本」の「トリプルクオート文字列」でも触れたが、Pythonではシングルクオート「'」またはダブルクオート「"」を3つ連続して並べた三重引用符で文字列を表現できる。

　三重引用符で囲まれた「トリプルクオート文字列」は改行コードを含んだ文字列などを記述するのに便利に使えるが、これがよく使われる場面がもう一つある。それがdocstringと呼ばれる使い方だ（「ドックストリング」「ドキュメント文字列」「ドキュメンテーション文字列」などとも呼ばれる）。

　docstringは、関数などの仕様（例えば、何をして何を戻り値とするのか、呼び出すのに必要なパラメーターは何かなど）をその利用者に対して説明するために、その定義に埋め込んだ形で記述する。