JavaScript のコメント

1. JavaScriptコメントの役割

JavaScriptのコメントは、JavaScriptコードの内容を説明し、リーダビリティ（可読性）を高めるために使用されます。 また、代替コードをテストする際に、特定の処理の**エグゼキューション（実行）**を防止するためにも活用されます。

2. 1行コメント (Single Line Comments)

1行コメントは // で始まります。

// からその行の末尾までのテキストは、JavaScriptによって無視され、エグゼキューションされません。

以下の例では、各コード行の前に1行コメントを使用して説明を加えています。

コード例

// 見出しを変更：
document.getElementById("myH").innerHTML = "マイ・ファースト・ページ";

// 段落を変更：
document.getElementById("myP").innerHTML = "私の最初の段落。";

次の例では、各行の末尾に1行コメントを記述してコードを解説しています。

コード例

let x = 5;      // xを宣言し、5を代入
let y = x + 2;  // yを宣言し、x + 2の値を代入

3. 複数行コメント (Multi-line Comments)

複数行コメントは /* で始まり、*/ で終わります。

/* と */ の間にあるテキストはすべてJavaScriptによって無視されます。

以下の例では、複数行コメント（コメントブロック）を使用してコードの説明を行っています。

コード例

/*
以下のコードは、
Webページ内の id = "myH" を持つ見出しと、
id = "myP" を持つ段落を変更するための
処理です。
*/
document.getElementById("myH").innerHTML = "マイ・ファースト・ページ";
document.getElementById("myP").innerHTML = "私の最初の段落。";

プロのアドバイス: 一般的には1行コメントを使用するのが最も一般的です。ブロックコメントは、正式なドキュメンテーションを作成する場合によく使われます。

4. 実行を防止するためのコメント活用

コードのエグゼキューションを防止するためにコメントを使用する方法は、コードのテスト（デバッグ）に非常に適しています。

コード行の先頭に // を追加することで、その行をエグゼキューション可能な行からコメントへと変更できます。

以下の例では、// を使用して特定の行のエグゼキューションを無効化しています。

コード例

//document.getElementById("myH").innerHTML = "マイ・ファースト・ページ";
document.getElementById("myP").innerHTML = "私の最初の段落。";

以下の例では、コメントブロックを使用して、複数の行をまとめて無効化しています。

コード例

/*
document.getElementById("myH").innerHTML = "マイ・ファースト・ページ";
document.getElementById("myP").innerHTML = "私の最初の段落。";
*/