JavaScriptのコメント記述方法・2種類

このページではJavaScriptコメントの記述方法について説明します。

コメントの記述方法は2つあります。 単一行のコメントと、複数行のコメントです。

単一行のコメントは//を使い、//から行末までの間にあるテキストをコメントとみなします。

複数行のコメントは/* から */までです。

// これが単一行のコメントです。(スラッシュ2つ)

/* これが
複数行の
コメントです */

コメントの記述場所

コメントは行頭に書く場合と、途中に書く場合があります。 どちらでもかまいませんが、見やすい方法で記述してください。


// カウンタ(行頭に書く場合) var count = 0; var total = 0; // 合計 (途中に書く場合) var tax = 0; // 税金 (途中に書く場合)

どちらを使えばいいの?

関数定義のコメント等は別として、 プログラム中にコメントを記述する場合は、「//」を使うことをおすすめします。 理由は、「/* */」だとコメントを入れ子にする時や、正規表現で「*」を使う場合に 不具合が出るからです。

例えば、「/* */」を使って次のようなプログラムを記述しているとします。


var a = 1;
var b = 2;
/* 加算 */
var c = a + b;

デバッグの最中に一時的に、このプログラム全体をコメントアウトしたい場合、 「/* */」で全体を囲ってもうまくコメントアウトされません。

下のように赤字部分がコメントとみなされて、最後の「*/」はエラーとなります。


/*
var a = 1;
var b = 2;
/* 加算 */
var c = a + b;
*/

一方、「//」を使ってコメントを記述している場合は、問題なくコメントアウトできます。


/*
var a = 1;
var b = 2;
// 加算
var c = a + b;
*/


プログラム作成中に、上記で行ったような「一時的にプログラムの固まりをコメントアウトする」ことは、よくあります。 そうした場合に備えて、プログラム中のコメントは「//」を使うことをおすすめします。

注意: プログラム中ではなく、関数定義用のコメントや、クラス定義用のコメントはこの限りではありません。 このような場合は「/* */」を使って記述することが多いです。

コメントアウトをデバッグに利用する

JavaScriptのコーディングをしている時に、 エラー箇所が不明なエラーが発生する場合があります。 そのような場合は、コメントアウトを使ってエラー箇所を絞り込んでいきます。

該当箇所不明のエラーが出たとします。その場合、ある程度のまとまった単位でJavaScriptのコードをコメントアウトして実行します。 そこでエラーが出なければ、コメントアウトした場所の範囲内にエラーがあることになります。 さらにコメントアウトの範囲を狭くして実行します。 こうやってどんどん絞り込んでいけばいずれはエラー箇所が見つかります。

原因不明なエラーが出た場合は、コメントアウトを利用してデバッグできることを知っておくと良いでしょう。

ツール・書籍紹介

まとめ・一覧

基本編

数値

文字列

正規表現

日付・時刻

配列

関数

オブジェクト指向

DOM操作

API

便利な小技集

用語

実践編

関連サイト