ドキュメント作成がバグ検出ツールになる？
2012年4月18日 11:20
taraiok 曰く、
コードを書くプログラマにとって、ドキュメント制作作業は「本来の仕事とは違う」と思いがちで、基本的には苦痛を伴うもののハズ。Made by Knight のブログ記事 "Documentation as a Bug-Finding Tool" ではバグ発見ツールとしてのドキュメンテーションについて述べられている (本家 /. 記事より) 。
ドキュメントは別の開発者にコードが引き継がれたときに、どのように動作するかという理解させるものだ。書いている自分以外「もう二度と見ないのでは」と思うコードでも、内部構造を手早く要約したドキュメントは、すべてを再チェックして構造を把握し直したり、書いた当時の忘れていた記憶を呼び戻す役割を持つ。しかし、ドキュメントを書くメリットはそれだけではない。書くためにコードを再チェックする過程で、小さなバグを発見できる可能性があるのだ。大きなプログラムになると、小さなバグを見つけるのは困難になる。コードレビューなどのチェッカーとドキュメント制作を組み合わせるだけで、高品質なコードを大量に書き起こすのに役立つだろう。
本家コメントではとある先人の格言が紹介されている。
「コードとドキュメントが合わない場合、それは両方とも間違っている」。
スラッシュドットのコメントを読む | デベロッパーセクション | プログラミング | バグ