第26回 「コメント(注釈)」
今回はコメント(注釈)について説明します。前回までは、ただプログラムを作成してきました。作成したプログラムは時間が経つと、どこが何の処理をしているかどうか分からなくなってしまう事があります。また、外部ファイルにしておいた場合や他人が再利用する場合に、何の処理をする関数かなども分からなくなってしまう事があります。
このような場合にはプログラム内に「コメント(注釈)」をつけておきます。
JavaScriptのコメントには以下の2種類が利用できます。
//
/* 〜 */
//は1行のみのコメントです。例えば
// 表示処理
function msg() { alert(0); }
のように使います。複数記述したい場合は
// 表示処理
// アラートダイアログを表示
// Copyright XXXX
function msg() { alert(0); }
のようにします。これ以外に、複数記述する場合には/*〜*/を使って記述する事もできます。この場合は以下のようになります。
/* 表示処理
アラートダイアログを表示
Copyright XXXX */
function msg() { alert(0); }
この2つは状況により使い分ければ良いでしょう。関数を利用している場合などは、引数がなんなのか、戻り値がなんなのかも明記しておけば再利用する場合に手助けになります。
ここらへんに関してはC言語やC++、Javaなどの言語を参考にするのも良いでしょう。
次回からは「フォーム処理」について説明します。