ドキュメントの重要性
「コードを書くのは楽しいけど、そのドキュメントを書くのは面倒くさいよ。」
殆どのプログラマはそう思っており、私もそんなプログラマの一人だったりします。
しかしながら、ドキュメントのないプログラムというのは殆ど無意味であり、実用上の価値は皆無といえます。

2007年11月17日ドキュメントの重要性
「コードを書くのは楽しいけど、そのドキュメントを書くのは面倒くさいよ。」 2008年02月24日コメントつけろよプログラマは自分でコードを書くことができるだけでなく、他人が書いたコードを (ある程度は) 読むことができなければなりません。 その際に最もゲンナリさせられるのが、コメントが全くないソースコードです。
腕の立つプログラマのコードというのはきちんと構造化されいるため、コメントに頼らずとも作者の意図をきちんと読み取ることができます。
しかし、そのようなコードを書くプログラマは、コメントもきちんと付けるもの。
むしろ、初心者や読みづらいコードを書くプログラマほど、コメントも疎かになる傾向があるようです。
などなど……。(いずれも、実際に言われたことがある。) |
SearchAbout コード保守About コード保守
Powered by
Movable Type 3.33-ja |