Pythonでの関数ドキュメントの出力

関数の本体には、実行する処理の要点を記述した文字列を記述できます。このような文字列は、通常、関数のドキュメントと見なされます。これは単一引用符で囲み、関数本体の最初の行に配置します。それを読むには、関数名をパラメータとして渡す特別な関数helpを使用する必要があります。

2つの数値を合計する関数があるとします。これについては、対応する情報を含む文字列がコメントとして残されています。

def getSum(num1, num2):
	'この関数は2つの数値を合計します'
	return num1 + num2

helpを呼び出して、getSumに何がコメントされているのか確認してみましょう。

help(getSum)

コードを実行すると、コンソールに関数名とそのドキュメントを含む行が表示されます。

Help on function getSum in module __main__:

getSum(num1, num2)
	この関数は2つの数値を合計します

関数helpを使用すると、標準関数のドキュメントも読むことができます。関数printについての情報を調べてみましょう。

help(print)

関数からドキュメント文字列のみを出力するには、helpに関数名の後に特殊な構文.__doc__を渡す必要があります。

help(print.__doc__)

月の名前のリストをパラメータとして受け取り、それらを大文字で出力する関数を作成してください。ドキュメントに関数の動作の要点を記述し、それをコンソールに出力してください。

関数sumについてのすべてのドキュメントを出力してください。

関数lenについてのドキュメント文字列のみを出力してください。