2009年02月17日

コメント文の重要性

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

*

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

コメント文が役に立つ点としては以下のようなことが考えられます。
1処理の流れや要約を簡単に知ることができる
2制作者の意図を知ることができる
3今後のためのメモを残せる
当たり前なことばかりで申し訳ありませんあせあせ(飛び散る汗)
では順番に説明していきます。



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



2
制作者の意図を残せるというのも、また大切な要素です。
例えば次のような処理があったとしましょう。
    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;
}
ああ、これは意図された処理なんだ、と理解できます。
ソースコードだけではよく分からない微妙なニュアンスも残せるわけです。



3
今後のためにメモを残せるという項目についてです。
自分でルール付けをして書いておけば、後から行う最適化やリファクタリングのときに便利です。
例えば、今後するべきことを書いておく場合。
    // TODO:とりあえずバブルソートで実装。今は問題無いが、
// 処理が重くなってきたときに別のソートに置き換える必要あり。
といった風に書いておけば、TODO:でgrepして見つけることが出来ます。
こうやって書いておく癖をつけておけば、後でやることを忘れていた、なんてことが減ると思います。



exclamation&question
ただ、何でもかんでもコメントさえ書けばいいというわけではありません。
例えば次のようなものはNGです。
    // 登録個数ループ。
for( int i=0; i<count; ++i ) {
:
:
}
コードを見たまま書いているようなコメントではあまり意味がありません。
今まで説明してきたように、処理の流れや意図が分かるように書く必要があります。
次のような感じです。
    // 登録されているものから検索。一番始めに見つけたデータを使用する。
for( int i=0; i<count; ++i ) {
:
:
}
これならば中で何をしたいのかがよく分かると思います。

*

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


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

posted by 管理人 at 16:05 | Comment(2) | プログラミング
この記事へのコメント
初めまして、ヘキサドライブ日記毎日読ませてもらってます。

プログラムを学んで複雑な事をしだすにつれて、基礎的な事の重要性が身に染みます。学んではいますが、ど忘れすることも・・・
このようなお話を書いて頂けると嬉しいです。
Posted by マサト at 2009年02月18日 15:51
毎日読んでいただきありがとうございます^^

できるだけ皆様の役に立つようなプログラミングに関することや、書籍の紹介をしていきたいと思っています。
最初は基礎的なことから、そして徐々に多岐に広がっていければと考えています。

これからもよろしくお願いいたします!
Posted by ヘキサドライブ平尾 at 2009年02月25日 10:46
コメントを書く
お名前:

メールアドレス:

ホームページアドレス:

コメント:

認証コード: [必須入力]


※画像の中の文字を半角で入力してください。
※ブログオーナーが承認したコメントのみ表示されます。