Pythonのドキュメントコメント(Docstrings)の書き方、何やら流派があるらしい。。 Googleスタイルを調べてみたので、その時の備忘録。 reStructuredText(reST)スタイル NumPyスタイル numpydoc – Numpy’s Sphinx extensions — numpydoc v0.9.dev0 Manual NumPyスタイルPython Docstringsの例 — Sphinx 1.5.6 ドキュメント Googleスタイル styleguide/pyguide.md at gh-pages · google/styleguide · GitHub GoogleスタイルのPython Docstringsの例 — Sphinx 1.5.6 ドキュメント Googleスタイルの例 Short Summary:簡単な1行説明。名前とか def
