[プログラミング] コメントドリブン開発 - コメントを書いてからコードを書く

マイコミジャーナルに小ネタがのっていました。

同氏は、自身が使っているプログラミング方法論として「コメントドリブン開発」を紹介している。コードを書く前にかならずコメントを書くというものだ。コメントに書くのは次の2つだ。
* コードの目的
* なぜそのように書くのかの理由
今ではコード1行に対してかならずコメントを書くか、だいたい2〜3行のコードに対してコメントを書くようにしているという。無駄が多すぎるような気がしなくもないが、同氏の主張も的を射たもので興味深い。

WebデベロッパのJames Edwards氏が、自身のブログで、「コメントドリブン開発」というものを提案しているそうです。単純に、コーディングする前に、コメントをささーと書いて整理してから、実際のコーディングするというだけの手法ですが、利点としては2つあるそうです。

  • どうやってロジックを書いたらいいかわからない状態でコメントを書き出すことで、問題を洗い出し、自分自身と対話することで考えを整理することができる。
  • コードは明瞭だが、コメントが書けない時 (コードはぱっと浮かんでくるものの説明が難しい)、コードの目的をはっきりさせり、ほかのプログラマにコードを説明する際のコメントとして適切なものとなる。

前者は、自分で考えを整理するため、後者は、他者にどう説明するか考えるためですね。

もう一つ僕が役に立つと思っているのは、ペアプロのときですね。

今、仕事で、コーディング経験が浅い人と一緒にペアプログラミングしてるんですが、コメントドリブン開発は役に立ってるような気がします。例えば、僕がコードを書く順番の時には、まずはどうコードを書くかコメントを書きながら説明します。それで大体の処理手順を分かってもらってから、だーっとコードを書いていきます。

こういう感じでやると、理解が促進されるようです。

他の○○ドリブンとかと違って、かなり子ネタですけど、みなさんも活用してみてください!