- 807 名前：デフォルトの名無しさん mailto:sage [2020/08/20(木) 12:18:54.29 ID:n3I6y8KW.net]
- プログラム自体をドキュメントとする。
例えば改訂履歴、関数のパラメータの説明やリターン値などの説明、
ドキュメントを自動生成してくれるツールや、関数を呼び出すときにそれらの説明を表示してくれるIDEなども有る。
jupyterなら関数の説明として表示してくれる。
java ならjavadoc
python ならdocstrnig
VSCode にはautoDocstringが有る。
書き方には色々ありNumpy スタイル、Google スタイルなど有る。
後でsphinx と言うツールでドキュメントとして出すことも可能。Python の公式ドキュメントはこれで作られている。
Numpyスタイル
https://qiita.com/simonritchie/items/49e0813508cad4876b5a
Googleスタイル
https://qiita.com/11ohina017/items/118b3b42b612e527dc1d
