【JavaScript入門】JavaScriptでのコメントの書き方

コメントの無いプログラムほど不親切なものはありません。

他の人が作ったプログラムを修正したり、自分がプログラミングしたものでも、何年も経過したものを再利用したりする際に、1からプログラムを解析しなければならないのと、コメントで処理の概要が書かれているのとでは大きく生産性が変わってくるでしょう。

コメント、つまり、プログラムとして実行されない文の記述は、プログラミング言語によりルールが違います。

JavaScriptのコメントは、コメント化できる範囲によって二種類あります。それでは、JavaScriptのコメントの記述ルールについてそれぞれご紹介しましょう。

1行コメントの記述ルール

// alert('test1');
alert('test2');
alert('test3');    // ここからは実行されません

上記のプログラムを実行すると次のようになります。

image6_1

image6_2

実行結果を見ても分かる通り、// と記述するとその左側に記述された1行はすべてコメントと見なされます。

プログラムの1行目に書かれた行はすべてコメントと見なされるため実行されず、test1と書かれたダイアログは表示されません。

3行目はダイアログを表示するプログラムの部分はコメントでは無いため実行されますが、// と書かれた後の記述はコメントと判断されます。

1行コメントは処理の概要を端的に表現したり、変数の説明をする際に非常に便利です。

可読性を上げるために、行頭に// を付加する方法か行の末尾に付加する方法かルールを決めておくと更に読みやすいプログラムになるでしょう。

複数行コメントの記述ルール

alert('test1');
/*
alert('test2');
alert('test3');
*/
alert('test4');

上記のプログラムの実行結果は次のようになります。

image6_3

image6_4

プログラムの実行結果を見ても分かる通り、/* と*/ で囲まれた部分は実行されておらず、コメントと判断されています。

// を2行目と3行目の行頭に付加しても同じ結果になりますが、もっと大規模なプログラムの改修やプログラムでエラーが発生した時に、原因となる行を探していくデバッグ作業では複数行コメントの方が便利でしょう。

コメントを上手に使いこなすとプログラムの可読性も上がります。誰が見ても分かりやすいプログラミングを心がけましょう。


イベント

2017/12/05(火)
Design Thinking Square