Pythonでは関数などを使用した際、コメント機能として説明文を挿入することができます。ここでは、Pythonにおける「docstring」について解説しています。
この記事の対象
Docstringって?
Docstring(ドックストリング)とは、Pythonの関数、クラスに記述するコメントのことです。
例えば、以下のように関数の真下に記述したりします。
def test(x,y):
'''testの計算'''
Docstringの型
#Docstringの型
def 関数名(引数a,引数b,...):
'''関数の説明文'''
#関数の処理
return (戻り値)
関数の真下に三重引用符で文字列を記述することで「docstring」として認識されます。
参照方法
REPLやEditorなどで「help(関数名)」と打ち込むことで説明文を参照できます。参照し終えたら「q」で終了できます。
または、プログラム内において「__doc__」属性を呼び出してprintする方法です。説明は「__doc__」属性に文字列として格納されているので、簡単に参照できます。
print(関数名.__doc__)
Docstringを用いた使用例
#Docstringを用いた使用例
def test(x,y):
'''testの計算'''
return (x+y)/2
print(test.__doc__) #出力結果は「testの計算」です。
記述する際は、インデントに注意する必要があります。また、help(関数名)とすることでも参照できます。
Docstringとコメントの違い
Docstring(”’)は説明を書くことが一般的で、参照できるものです。それに対して、コメント(#)がプログラム上無視される文字列です。
Docstringとコメントの使い分けは会社・組織のプログラミング文化によって違うので、明確にこれだというルールは存在しません。