JavaScript のコメント記述方法

JavaScript コメントは、JavaScript コードを説明し、読みやすくするために使用できます。
代替コードをテストするときに実行を防ぐためにも使用できます。

一行コメント

1行のコメントは // 。で始まります。
// 行の間と行末の間のテキストは JavaScript によって無視されます(実行されません)。

一行コメントの例

この例では、各コード行の前に1行のコメントを使用しています。

// Change heading:
document.getElementById("myH").innerHTML = "My First Page";

// Change paragraph:
document.getElementById("myP").innerHTML = "My first paragraph.";

行末コメントの例

この例では、各行の終わりに1行のコメントを使用して、コードを説明しています。

var x = 5;      // Declare x, give it the value of 5
var y = x + 2;  // Declare y, give it the value of x + 2

複数行コメント

複数行コメントはで始まり、/* で終わり */ ます。
/* との間のテキストは */ JavaScriptによって無視されます。

複数行コメントの例

この例では、複数行のコメント(コメントブロック)を使用してコメントでコードを説明しています。

/*
The code below will change
the heading with id = "myH"
and the paragraph with id = "myP"
in my web page:
*/
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";

1行コメントを使用するのが最も一般的です。
ブロックコメントは、正式なドキュメントとしてファイルの冒頭や関数の説明文によく使用されます。

コメントを使用して実行を停止する

コードをテストする際に、コメントを使用してコードの実行を防ぐこと事で動作確認することができます。
// コード行の前に追加すると、コード行がコメントに変更されます。

一行コメントを使用して実行を停止する例

この例では、// を使用して、コード行の1つが実行されないようにします。

//document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";

複数行コメントを使用して実行を停止する例

この例では、コメントブロックを使用して、複数行の実行を停止します。

/*
document.getElementById("myH").innerHTML = "My First Page";
document.getElementById("myP").innerHTML = "My first paragraph.";
*/