Pythonのdocstringとは？3か月後の自分を助ける説明の書き方を初心者向けに解説
Pythonのdocstringを、コードに説明を書き慣れていない方にもわかるようにやさしく解説します。コメントとの役割の違い、PEP 257が示す1行と複数行の書き分け、help()が読んでいる正体、GoogleスタイルやNumPyスタイルの選び方、doctestで使用例をそのままテストにする方法、そして実装とずれたときの怖さまで。手元で動かした結果と比較表で整理します。
記事を読む