コメント とは、スクリプト内のメモ書きのことをいいます。
このコメントはスクリプトの実行時には無視されるため、実行されることはありません。
では、どのようなときにこのコメントを使うのでしょうか?
例えばですが、しばらく期間をあけてコードを読み返した際に、自身がどのような考えで実装したのか思い出すのは大変です。
そのようなときにコメントが書かれているとこのような苦労をせずに済みます。
同様に、自身ではなく他の人にソースを読んでもらうことがあった場合も、
自身がどのような考えで実装したのかを伝えることができます。
このように、コメントを活用することで、
プログラムを作った人自身、もしくはあとで読む人(将来の自分を含む)がわかるように説明を書き残すことができます。
なお、JavaScriptのコメントは2種類あります。
それぞれのコメントを使い方について解説していきます。
「//
」で始まる記述はその行の終わりまでコメントとして扱われます。
1行のみコメントにしたい場合は、その文頭に「//
」を入れることでコメントにすることができます。
function myFunction() {
// 実行されないので半角英数字や半角記号以外の文字を入れることができます。
console.log('Hello GAS!'); // 行の後ろにも入れることができます。
}
「/*
」で始まる文字列は「*/
」までの記述をコメントとして扱います。
これにより、複数行にわたるコメントを書くことができます。
function muFunction() {
/*
1行目
2行目
*/
console.log('Hello GAS!');
}
コーディングをしていて、「このステートメントは今は実行したくないな」というときにもコメントは活躍します。
実行したくないステートメントをコメントにすることで実行されないようにすることができます。
このように一時的にコメントにすることを「コメントアウト」といいます。
// 2回目のconsole.log()は実行したくない場合
function myFunction() {
console.log('Hello GAS!');
// 2回目のconsole.log()をコメントアウト
// console.log('Hello GAS!');
}
コメントアウトはショートカットキーがあり、コメントアウトしたい行を選択した上で、
WindonwsはCtrl + /
、Macはcontrol + /
でコメントアウトをすることができます。
逆にコメントを解除したい場合も同じ手順で行うことができます。
CSSのコメントはJavaScriptのブロックコメントと同じ形式で、インラインコメントは使うことができません。
HTMLもコメントはインラインコメントはなく、ブロックコメントがありますが、JavaScriptとは違い <!--
と -->
で囲まれます。