ドキュメント

プログラマの中にはドキュメントを書くのを嫌がる人がたくさんいるそうだ。
自分も「そんな暇があったらコードを書け」って言っていた時期があった。
というのもコードに変更を加えたらドキュメントにも変更を加えなきゃいけない。
これはものすごくめんどくさいので「ドキュメントなんて書いてられるか」なんて
よく思ったものだ。しかし, そうでもなかった。

世の中にはソースコードのコメントからドキュメントを生成するツールがあるのだ。
自分もそういうのがあることは知っていた。しかし, (自分の持っている)プログラミングの本
ではそういった類のがほとんど扱われていないので特に興味も湧かなかった。
「そういうのを使った方がいいよ」みたいな話は達人プログラマー―システム開発の職人から名匠への道を読むまで聞いたことがなかった。いや, 聞いたことはあったかも知れないが多分まともに聞いてなかったんだろう。

というわけで最近はまともにコメント(ドキュメント)を書くことにしている。
さすがに使い捨てのプログラムにはそんなに詳細に書かないけど。