docstring
Pythonにおけるクラスやメソッドの
説明文
のこと
三重引用符
(
"""
)でテキストを囲むことでdocstringになる
コメント文(
#
から始まる文)はダメ
code:python
def my_method():
"""
これがdocstring
"""
参考
Python docstringのスタイルと書き方 - Qiita
Python 可読性を上げるための、docstringの書き方を学ぶ(NumPyスタイル) - Qiita
NumPyスタイル
と呼ばれる書き方についての解説
Mijinko_SD.icon
はこっち派
GoogleスタイルのPython Docstringの入門 - Qiita
Googleスタイル
と呼ばれる書き方についての解説
#Python