【6日目】docstringで関数に説明文を付けてみる

こんばんは、なぺです。

今回はdocstring（ドキュメンテーション文字列）を作成してみます。

docstringとは、関数の説明文です。

例えば下記のような、xの5乗を返す関数fifjの場合

def fifj(x):
return x**5

私がつけた冴えない関数名"fifj"（５乗→fifth jo→fifj）だけだと、

どんな関数か分かり難いです。

そこで、docstringで関数宣言の直後に説明文を付けます。

まず、docstringの最初の行で、この関数が何をするものなのかについて記述します。

Returns x**5. （←この関数は引数の5乗を返します）

残りの行には、関数の引数、引数の型、関数が返す値について書きます。

:param x: int. 　（←ｘは整数です）
:return: the fifth power of x　（←返り値はxの5乗です）

あとは文字列として関数宣言の直後に挿入するだけです。

def fifj(x):
"""
Returns x**5. 
:param x: int. 
:return: the fifth power of x　
"""
return x**5

docstringは文字列であればいいので、「,」や「""」で囲んでも可能らしいですが、

慣例的にトリプルクォートが使われることが多いということなので、それに従いました。

docstringは以下の方法で表示することが出来ます。

・print(関数名.__doc__)

・help(関数名)

出力結果は下記です。

>>> print(fifj.__doc__)

Returns x**5.
:param x: int.
:return: the fifth power of x

>>> help(fifj)
Help on function fifj in module __main__:

fifj(x)
Returns x**5.
:param x: int.
:return: the fifth power of x

今日は以上です。

 はあ、機械学習とか、いつになったらできるのやら～笑