コメントを入れる方法

コメントの記述方法

JavaScriptでコメントを記述する方法は、2とおりあります。1つめは、//の後に記述する方法です。

// コメントです。
let x = 1; // xの初期値

1行目のように行全体をコメントにすることもできますし、2行目のように途中からコメントにすることもできます。

もう1つの方法は、/*と*/の間に記述する方法です。

/* コメントです。 */
let x = 1; /* xの初期値 */

/*
ここは、
コメントです。
*/

これは、複数行をコメントにできますが、入れ子(コメントの中にコメントを入れる)にはできません。

見出しのような使い方

コメントの使い方の1つは、見出しのように記述することです。以下は、例です。

// --- 画像入れ替え処理 ---
for ( y === 1 ) {
・・・
}

以降が、どのような処理をしているのかわかるように記述します。

覚書として使う

覚書としても使えます。以下は、例です。

let x = 2; // 2020年10月1日：A処理追加により1から2に変更

後で見ると疑問に思うかもしれない処理について、コメントを入れておくと思い出しやすくなります。

コメントアウト

コメントは、一時的に削除したいけど元に戻す可能性もあるため消したくない、と言った時にも使えます。これを、コメントアウトと呼びます。以下は、例です。

/*
for ( y === 1 ) {
・・・
}
*/

もし、コメントにしてうまく動作したのならそのまま消せますし、必要な処理であればコメントを外してすぐ元に戻せます。