1. TOP
  2. プログラム
  3. ソフト
  4. python
  5. docstring

docstring

2019-04-29_100704_RM3

関数本体の先頭に

文字列を組み込めば、関数定義にドキュメントをつけることができる
関数のdocstringを表示するには、Pytonのhelp()関数を呼び出す。

>>>def echo(anything):
>>> 'echoは、与えられた入力引数を返す'
>>> return anything


>>>help(echo)


Help on function echo in module __main__:

echo(anything)
echoは、与えられた入力引数を返す



整形前の素のままのdocsteringを見たい場合には、 >>>print(echo.__doc__)



echoは、与えられた入力引数を返す