コメント文の重要性

こんにちは。ザンギエフ大好き、平尾です。
すごく暖かくなったと思ったら、急に寒さが戻ってきました
寒暖の差が激しいので体調を崩さないか心配です。
皆様もお気をつけください。

*

今回はプログラムを学んでいる学生に向けて、コメント文の話をしたいと思います。
コメント文は実際に処理として組み込まれるわけではないですが、大変重要なものです。
プログラマとして仕事をしている方なら、よりその重要性を感じているのではないでしょうか。

コメント文が役に立つ点としては以下のようなことが考えられます。

処理の流れや要約を簡単に知ることができる
制作者の意図を知ることができる
今後のためのメモを残せる

当たり前なことばかりで申し訳ありません
では順番に説明していきます。



：
処理の流れや要約を簡単に知ることができる。ごく普通の理由です。
ソースコードを見れば全ての処理を知ることはできます。
しかし処理を理解するのに必要なのは、まずはおおまかなアルゴリズムだったり、処理の流れだったりします。
そんなときはコンピュータに実行させる単位で見るより、人間に分かる単位で書かれたものを見る方が圧倒的に効率がいいわけです。
自分が作ったものでも、あまりにも前のソースだと忘れたりしますが、そんなときも役に立ちます。



：
制作者の意図を残せるというのも、また大切な要素です。
例えば次のような処理があったとしましょう。

    switch( mode ) {
    case MODE_INITIALIZE:
        initialize();
    
    case MODE_UPDATE:
        update();
        break;
    }

最初のケースの中、initialize(); の後にbreakが入っていないのはバグじゃないか？と思いますよね。
でも以下のように一文入っているだけで、

    switch( mode ) {
    case MODE_INITIALIZE:
        initialize();
        // breakせずに引き続き更新処理を行います
    
    case MODE_UPDATE:
        update();
        break;
    }

ああ、これは意図された処理なんだ、と理解できます。
ソースコードだけではよく分からない微妙なニュアンスも残せるわけです。



：
今後のためにメモを残せるという項目についてです。
自分でルール付けをして書いておけば、後から行う最適化やリファクタリングのときに便利です。
例えば、今後するべきことを書いておく場合。

    // TODO:とりあえずバブルソートで実装。今は問題無いが、
    // 処理が重くなってきたときに別のソートに置き換える必要あり。

といった風に書いておけば、TODO:でgrepして見つけることが出来ます。
こうやって書いておく癖をつけておけば、後でやることを忘れていた、なんてことが減ると思います。



：
ただ、何でもかんでもコメントさえ書けばいいというわけではありません。
例えば次のようなものはNGです。

    // 登録個数ループ。
    for( int i=0; i＜count; ++i ) {
    	:
    	:
    }

コードを見たまま書いているようなコメントではあまり意味がありません。
今まで説明してきたように、処理の流れや意図が分かるように書く必要があります。
次のような感じです。

    // 登録されているものから検索。一番始めに見つけたデータを使用する。
    for( int i=0; i＜count; ++i ) {
    	:
    	:
    }

これならば中で何をしたいのかがよく分かると思います。

*

コメント文という、プログラムにおける初歩の話をしましたが、少しはお役に立てたでしょうか？
役に立つようでしたら、これからもこういった基礎的な話などを書いていきたいと思います。


P.S.
会社説明会のエントリー状況がとても好調で、3/25の東京会場は残りわずかとなっています。
弊社に興味のある方はお早めのエントリーをお願い致します！