忙しい研究者のためのテストコードとドキュメントの書き方 - Qiita

はじめに 「研究用のプログラムにもテストコードやドキュメント書いたほうがいいよね。」 「分かっちゃいるけど、そんな面倒なことやってられないよ。」 という研究者あるあるを解決すべく、僕が普段実践している開発スタイルを紹介します。 この開発スタイルのすごいところは： テストやドキュメントを一切書かない場合と比べて 追加の工数がほぼゼロ。 普通にコーディングしているだけで、いつのまにかテストコードとドキュメントまでできあがっている。 実装、コメント、テスト、ドキュメントが自然に同期するので、保守しやすい。 Pythonを例に紹介しますが、コメント内にテストを書けるツールと、コメントからドキュメントを生成できるツールをもつ言語ならばどれにでも応用できるはずです。 この開発スタイルに至った背景 ソフトウェア開発において、テストコードやドキュメントを整備することでプログラムの品質が向上することは広く知

[hiroomi]

“テストによって何を実装すべきかが明確になり、実装で悩む時間が短縮されます。”

[hnishi2509]

doctest の話もある

[masa8aurum]

1人プロジェクトで効率的なやり方。コメント内にテストを書けるdoctestを使う

[yarumato]

“Python。チーム開発向け方法論は、個人開発者には生産性下げるのも多い。上がるものだけ採用。docstring（関数テスト）をいきなり書き、API設計のメモ帳として使う。doctestする。テスト通るように実装。コメント再利用”