JavaScriptでのコメントの書き方
Updated
2021/8/8 9:31
Author
Jumpei Ikegamiorder
7
JavaScript中でプログラムとは別にコメントを残すことができます。
コメントを使う目的と注意点
コメントとは、次の例にあるように、実装に影響を与えずにプログラム中にメモを残すためのものです。
JavaScript
コメントを書いておくことで、後からプログラムを読み返したときにも変数の意味や処理の流れを理解しやすくなります。特に、プログラムを読んだだけではわかりにくい実装背景や裏事情がある場合は、コメントとして残しておいた方がいいでしょう。
一方、コメントを書き過ぎるとプログラム自体の見通し（可読性）が悪くなります。コメントを書く前に、次のような方法でプログラムをわかりやすくできないか、考えてみましょう。
- 文字列や数値などを適切な名前の変数に格納する
- 処理を適切な名前の関数として切り出す
また、実装理由などコメントしたい内容が多い場合は、ドキュメント管理系のWebサービスなどにまとめて記載し、プログラム中のコメントにはそのドキュメントのURLだけを記載するという方法もあります。
JavaScriptに慣れないうちはコメントを多用してでも理解を優先するべきかもしれません。しかし、ある程度慣れた後はなるべくコメントは最小限にとどめるよう心がけましょう。
なお、サンプルコードでは説明のためにコメントを多めに付与しています。
コメントアウトとは？
コメントを使うもう一つの目的として、「プログラムの特定の行を一時的に無効化する」というものがあります。
プログラムを書いていると、いつか使うかもしれないけどいったん無効にしたい処理が出てくることがあります。たとえば、次のようにページ上の要素を取得するプログラムで、取得結果をコンソールのログで確認したいケースがあったとします。
JavaScript
確認がし終わったら、ログを出力している行は不要になります。しかし、またログで結果を確認したくなる場合がありそうです。そんなときは、ログを出力している行の先頭に//を書きましょう。その行はコメントになり、プログラムの実装上は無効化されます。
JavaScript
もしもまたログを出力したくなった場合は、行頭の
//を消すだけで元に戻すことができます。この「プログラムの特定の行を一時的に無効化する」ことを「コメントアウト」といい、コメントアウトした行を元に戻すことを「コメントイン」と言います。
ちなみに、プログラムを書く用のテキストエディタであれば、コメントアウトとコメントインを一発で実行するためのショートカットキーが設定されています。一般的には、Macの場合は「Cmd + /」、Windowsの場合は「Ctrl + /」です。複数行を選択したまま実行すると、まとめてコメントアウトできます。
JavaScriptでのコメントの書き方
ここからは、JavaScriptでのコメントの書き方を紹介します。なお、HTMLやCSSなどの他の言語ではコメントの書き方も異なるので、注意してください。
1行コメントを書く
コメントを残したい場合は、スラッシュを2つ連ねた後に書きます。
JavaScript
コメントはあくまでもプログラムを読む人間のためのものなので、プログラム実行時には無視されます。
次のように、行の途中からコメントにすることもできます。その場合、スラッシュ2つの直後からコメントになります。
JavaScript
複数行のコメントを書く
複数行に渡るコメントを書きたいときは、全ての行の行頭にスラッシュ2つを付与します。
JavaScript
ただし、行数が増えると面倒なので、
/*と*/で囲むことで複数行をまとめてコメントとすることもできます。JavaScript