タグ

方法論に関するmoqadaのブックマーク (1)

  • 【レポート】コメントドリブン開発 - コメントを書いてからコードを書くことの効能 | エンタープライズ | マイコミジャーナル

    ソースコードにコメントを記載するべきか、どの程度コメントを入れるべきか、どういった内容を書くべきかはプログラミング普遍の議題であって、永遠に解決しない問題の1つのようなところがある。よく言われるのは、短く簡潔で、他人がそのコードを読んだ時に理解を助けるように「なぜ」そのコードをそのように書いてあるのかをコメントとして入れるべきということだ。理にかなっているし、もっとも無難な方法だ。 しかし逆にコメントを書かない方がいいとする考えもある。それはコードとコメントが必ずしも一致していないことがあるからだ。また最初は一致していても、コードに変更を加えていくうちにコメントと内容が一致しなくなり、コメントとコードの不一致が作業ミスの原因になるというものだ。これも一理ある。これを突き詰めれば、コメントをまったく書かなければデベロッパは大量のコードを追って読む必要があり、初期コストは高いかもしれないが結局

    moqada
    moqada 2007/10/13
    2~3行毎にコメントを書く。コードを書く前にそのコードの目的となぜそのように書くのかの理由を書く。
  • 1