Pythonのdocstringの書き方について

3つの書き方

• google style:

  • Example Google Style Python Docstrings — napoleon 0.6.0 documentation

• numpy style:

  • Example NumPy Style Python Docstrings — napoleon 0.6.0 documentation

• reST:

  • Miscellaneous markup — Sphinx 1.6.5+ documentation
  • reStructuredText マークアップ仕様 — Docutils documentation in Japanese 0.12 ドキュメント
  • Using Docstrings to Specify Types - Help | PyCharm

自分の基本的な書き方

基本的にはreSTの書き方しているつもり。

''' 1行関数・クラス説明

複数行説明...

:param type param-name: param-description
:return: return-description
:rtype: return-type
'''

docstringのtypeの書き方

• Type Hinting in PyCharm - Help | PyCharm