以下のような、pythonを作り実行してみました。
python
1# -*- coding: utf-8 -*-
2def add(x, y):
3 """
4Returns x + y.
5:パラメーター x: int.
6:パラメーター y: int.
7:戻り値: int sum of x and y.
8"""
9 return x + y
10print(add.__doc__)
結果は
Returns x + y.
パラメーター x: int.
パラメーター y: int.
戻り値: int sum of x and y.
と出力されました。
関数中に書いた"""~"""('''~'''もか-未検証-)はdocstringと解釈され、printしたり、IDEで表示できるようになるみたいですね。
詳細は、pythonのドキュメントを調べるのが良いのではないでしょうか。
いつかはpythonのドキュメントをじっくり読んでみたいのですが時間がないのでなかなかできません。
こんなサイト[Python]可読性を上げるための、docstringの書き方を学ぶ(NumPyスタイル)
がありましたので勉強してみたいかがでしょうか。
『paramがどのような意味なのか』はパラメーターを説明したいのでしょうね(慣習かチームの統一性を図っているのでは)。
『Returnsと複数形になっている』のは、記述したプログラマーの頭を覗かないとわかりませんね。
バッドをするには、ログインかつ
こちらの条件を満たす必要があります。