【Python】関数のコメント docstring の設定と確認方法
こんにちは、ピコピコくんです。
今回は関数の説明文 docstring について書きました。
docstringとは
関数を定義したときに、その関数の説明を書いた文字列をdocstringと言います。他の人が関数の中身を読まなくても引数や戻値が理解できるように書いておくと便利です。
docstringの設定方法
docstringは関数を定義した直後に、二重引用符（ダブルクォーテーション）を3つ連続で書きます。
def func_with_docstring():
""" この関数はdocstringの練習用関数です。
呼び出されると 0 を返します。
"""
return 0
docstringの確認方法
__doc__属性
関数の __doc__ 属性にdocstringが格納されています。
# func_with_docstring関数の__doc__属性を表示
func_with_docstring.__doc__
実行結果
' この関数はdocstringの練習用関数です。\n\t呼び出されると 0 を返します。\n\t'
helpで確認
組み込み関数 help でdocstringの中身を表示できます。下記のようにhelp ( 関数名 )と記述するとその関数に設定されたdocstringが表示されます。
help(func_with_docstring)
実行結果
Help on function func_with_docstring in module __main__:
func_with_docstring()
この関数はdocstringの練習用関数です。
呼び出されると 0 を返します。
参考書籍
Pythonで学ぶアルゴリズムとデータ構造で勉強中です。
スポンサー広告
