Codelogy

2007年11月17日

ドキュメントの重要性

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

>> 続きを読む...

2008年02月24日

コメントつけろよ

プログラマは自分でコードを書くことができるだけでなく、他人が書いたコードを (ある程度は) 読むことができなければなりません。 その際に最もゲンナリさせられるのが、コメントが全くないソースコードです。

腕の立つプログラマのコードというのはきちんと構造化されいるため、コメントに頼らずとも作者の意図をきちんと読み取ることができます。 しかし、そのようなコードを書くプログラマは、コメントもきちんと付けるもの。 むしろ、初心者や読みづらいコードを書くプログラマほど、コメントも疎かになる傾向があるようです。
彼らが自分のソースコードにコメントを付けない理由として挙げるものとしては、

  • 時間がなかったから。(急いで修正したから。)
  • 公開するつもりのないコードだから。
  • コメントを付けると、コメントに頼ってコードを読むようになってしまうから。
  • コメントを入れるのと、素人のコードっぽく見えるから。
  • コードの可読性は品質には影響しない。可読性をあげて良いことがあるのか?
  • などなど……。(いずれも、実際に言われたことがある。)
    人それぞれに事情や主義主張があるのは分かりますが、正直「そのコードの保守運用をさせられるこっちの身にもなってくれ」と言いたくなります。(そして、実際に言っています。^^;)

    >> 続きを読む...

    About コード保守

    ブログ「Codelogy」のカテゴリ「コード保守」に投稿されたすべてのエントリーのアーカイブのページです。過去のものから新しいものへ順番に並んでいます。

    前のカテゴリはアルゴリズムです。

    次のカテゴリはレポートです。

    他にも多くのエントリーがあります。メインページアーカイブページも見てください。