本記事では、JavaScriptにおけるコメントアウトの方法やコメントを残す理由を、初心者の方でも分かりやすく解説しています。プログラミングにおいてコメントを残すことはとても重要なので、この機会に覚えてみてください!
コメントアウトとは
コメントアウトとは、プログラムを実行しないでメモが残せる機能です。プログラムの説明やメモだけでなく、プログラムを一時的に無効化させるためにも使用できます。
コメントアウトの方法
「一行のコメントアウト」と「複数行のコメントアウト」の場合では、コメントアウトの方法が異なるのでそれぞれ紹介します。
一行のコメントアウト
一行の場合には、先頭に「//」と記入します。
// 一行コメントアウトする場合
複数行のコメントアウト
複数行の場合には、コメントアウトしたい内容を「/*」と「*/」で囲みます。
/*
複数行
コメントアウトする場合
*/
ショートカットキー
ショートカットキーを毎回タイピングするのは手間がかかります。すぐにコメントアウトができるように、ショートカットキーを覚えておくようにしましょう。
※エディタによって異なる可能性があるので注意してください。
<一行のコメントアウト>
- Windows: Ctrl + /
- Mac: command + /
<複数行のコメントアウト>
- Windows: Ctrl + Shift + /
- Mac: command + / または command + option + /
コメントアウトを残す理由
コメントアウトする理由は主に2つです。
- 説明を残す
- エラーを探す
1つずつ解説していきます。
コードの説明を残す
後で自分が見返した時や、他の人がコードを見た時に分かりやすくするためにコメントを残しておきます。なぜそのコードを書いたのか、この引数の意味は何か、などを残しておくことで、後に修正することになっても対応がスムーズにできます。
エラーを探す
コメントアウトはメモとして使用するだけでなく、エラーを探すためにも利用できます。
JavaScriptを書いている途中でエラーが出た場合、どのコードが原因なのかがすぐに分からないことがあります。そんな時は、怪しいコードを1つずつコメントアウトしていけばエラーの原因が分かるはずです。