単一行コメントと複数行コメント | コメントの記法 | JavaScript 超完全入門基本から発展までのすべて

INDEX

コメントとは？

JavaScriptのコメントとは、プログラムの説明やメモを書くための記述です。

コメントに書かれた内容はJavaScriptエンジンによって実行されず、プログラムの動作には影響しません。

コメントは、自分や他の開発者がコードを理解しやすくするために利用されます。

JavaScriptには次の2種類のコメントがあります。

単一行コメントは、1行だけコメントを書く場合に使用します。

//より後ろの内容はコメントとして扱われます。

let x = 10; // 変数xに10を代入

console.log(x); // xの値を表示

この例では、コードの横へコメントを書いています。

複数行コメントは、長い説明を書く場合や複数行にわたってコメントを書く場合に利用します。

/*で始まり、*/で終了します。

/*
  ここは複数行のコメントです。
  複数行にわたって説明を書くことができます。
*/

let y = 20;

console.log(y);

処理の概要や関数の説明など、少し長いコメントを書く場合によく利用されます。

コメントは説明だけでなく、コードを一時的に実行しないようにするコメントアウトにも利用できます。

const name = "Taro";

// console.log(name);

console.log("処理を続行");

この例では、console.log(name)だけが実行されません。

デバッグ中や動作確認を行う際によく利用されます。

コメントは次のような場面で役立ちます。

コメントは多ければ良いというものではありません。

現在では、「コードを読めば分かること」はコメントに書かず、「なぜその処理が必要なのか」を書くことが推奨されています。

例えば、次のようなコメントはあまり意味がありません。

// xに10を代入する
const x = 10;

一方、次のようなコメントは理由が分かるため役立ちます。

// APIの仕様上、10秒待ってから再実行する
setTimeout(loadData, 10000);