docstring
関数やクラスの解説を書くところ、書いたもの
Pythonだとダブルクォーテーション3つを続けたもので囲うと、docstringだとみなされる
code:python
"""
ここがdocstringです
"""
# ここはコメントです
コメントもdocstringも、プログラムは意味ある文として実行はしない(?)けど、コメントの代わりにdocstringを使うのは不適切
複数行コメントにしたいときとかは、ついdocstringにしたくなってしまうけど我慢
docstringはある種「意味のある文」なので、完全に無視はしない
jupyterlabとかvscodeとかでその真価を発揮する→関数の説明をマウスオーバーで表示
書き方にも流派がある
NumPy派
NumPyで使われている書き方→Numpy派のdocstring書き方
Google派
scikit-learnなどGoogle製のライブラリで使われている書き方
JavaScriptにも似たようなのがあるらしい