「コメント」の重要性

  • このエントリーをはてなブックマークに追加
  • Pocket

From: リカレントテクノロジー 高坂一城
新宿本校にて

kohsaka

プログラミング言語を学ぶとき、
「コメント」は最初に習う項目の一つです。

「コメント」とは、
「ソースコードに書かれている注釈」 です。

そのため、コメントがあろうがなかろうが、
実際のプログラムの動作には全く
影響を及ぼしません。

プログラムを実行するときには、
コメントは全て無視されます。

では、なぜコメントを書くことが
必要なのでしょうか。

ある、調査機関によると、

「ソースコードの平均19%がコメントである」

という調査結果が出ています。

なぜ「コメント」が必要か

その理由は、
「ソースコードをメンテナンス(保守)する人に
情報を伝えるため」
です。

多くの場合、プログラムを作成する人と
そのプログラムをメンテナンスする人は異なります。

どんな「コメント」を書けばいいのか

では、どんなコメントを書けばよいのでしょうか。

今までに私が見てきたコメントで一番多いものが、

「何をしているコードなのか」

というものです。

例えば、

「ここでファイルにデータを出力する」
「もし値が0ならばエラー処理する」  などなど...。

このようなコメントは必要なのでしょうか??

「何をしているコードなのか」は、
ソースコードを見ればわかることです。

「コメント」として書くべきこと

ソースコードをメンテナンスする人が知りたいのは、

「なぜそのようなコードになったのか」

です。

ソースコードに手を入れて変更するにも、
なぜそのようになっているのかが
解らないと手を入れられません。

一見すると回りくどいソースコードだけど、
もしかしたら何か理由があるのかも?

そう考えると迂闊に手は入れられません。

「何をしているコードなのか」は、
時間をかければ読み解くことができます。

しかし、
「なぜそのようなコードになったのか」は、
そのソースコードを書いたプログラマの
頭の中にしかありません。

その意図をソースコードから読み取ることは
できません。

だからこそ、コメントで補う必要があるのです。

「コメント」も成果物の一部

最初にも書きましたが、
コメントはプログラムの動作には影響しません。

実際にプログラマに話を聞くと、
「なんとなく」でコメントを書いている人も多いです。

しかし、
コメントもソースコード(成果物)の一部です。

また、ソースコードをメンテナンスする人への
大切な情報源です。

実際にプログラムを書く際には、
「なんとなく」ではなく、気を遣ってコメント
を書くようにしましょう。

--------------------------------------------
PS.これからITを勉強したいあなたへ
高坂も登壇!参加費無料のセミナーはこちら↓↓
IT業界セミナー・授業体験セミナー
--------------------------------------------

  • このエントリーをはてなブックマークに追加
  • Pocket

このページの続きや関連ページは下記から一覧で確認できます。

SNSでもご購読できます。

コメントを残す

*

未経験からの育成制度も充実
IT講師に興味はありませんか?

リカレントテクノロジーでIT講師の積極募集を開始! 経験・未経験問わずご応募可能。育成制度で講師スキル向上も目指せます

IT講師に応募する