コメントドリブン

新人ちゃんから「shikakuさんのコードは読みやすいです」と言われた。

どのへんが？と聞くと「コメントがいっぱいあるから」とのこと。

そういえば自分がコード書くときはまずコメントで流れを書く。

俺言語で書くって感覚。

たしかコードコンプリートに書いてあった方法だと思う。

// かなーり単純なサンプル
void main(){
    
    // <初期化>

    // <表示>

    // <キー待ち>

    // <終了>
}

俺言語でイメージできるようにかいたら、続いてコードで書いていく

そのとき俺言語はそのまま残しておく

// かなーり単純なサンプル
void main(){
    
    // 初期化
    char buff[] = "Hello shikaku";

    // 表示
    printf("%s\r\n",buff);

    // <キー待ち>

    // 終了
    return;
}

こうすると処理のブロックごとにコメントが自然と残る。

まだ実装してない部分は　＜・・・＞　で残しておく

そして、不具合があったり仕様変更があったら、
その不具合の発見に至るプロセスや、GREPするためのヒント、誰からの指示か実名で書き残したりする。

特に人に読まれることを意識したルールじゃなかったんだけど

新人ちゃんにもわかりやすいといってもらえるってことは

誰にでもわかりやすいコードになっているってこと。

うれしいですね。

こういうのも一つの美しいコードなのかな。

Code Complete第2版〈上〉―完全なプログラミングを目指して

Code Complete第2版〈下〉―完全なプログラミングを目指して

※追記
こんな記事もあった。

コメントドリブン開発 - コメントを書いてからコードを書くことの効能