JavaScript - コメントの書き方

JavaScript のコメントの書き方は大きく分けて２つあります。

単一行のコメントと、複数行のコメントです。

プログラムコードを読みやすくするためにもコメントは適切に記述しましょう。

単一行コメント

単一行コメントは //（スラッシュ2つ）を使います。

// これは単一行のコメントです。

次のように、行頭でも行の途中でもどちらでも構いません。

どちらもコメントとして認識されます。

// コメント（行頭）
var i = 0;

var k = 0; // コメント（途中）

次のように、// を複数行にわたって記述し、コメントブロックを作ることもできます。

//--------------------------------------
// コメント
//--------------------------------------
var i = 0;
var k = 0;

複数行コメント

複数行コメントは /* と */ で囲まれた部分です。

/* 
複数行
コメントです
*/

単一行コメントとしても使えますが、単一行の場合は // を使いましょう。

/* 単一行コメントとしてもつかえますが、 */

// 単一行の場合はスラッシュを使いましょう

どちらを優先的に使う？

プログラム中で使う場合は、単一行コメントの // を優先的に使いましょう。

複数行コメントの /* */ を使うと、正規表現の場合や、コメントの入れ子の場合に 不具合が生じるからです。

関数定義部分やプログラム定義部分などのまとまった複数行コメント部分は別として、 プログラム中はなるべく 単一行コメントの // を使うことをおすすめします。

まとめ

・JavaScript のコメントは大きく分けて2種類あります。

・単一行コメントは // （スラッシュ２つ）。

・複数行コメントは /* ～ */ で囲まれた部分。

・プログラム中のコメントはなるべく // で記述することをおすすめします。