JavaScriptのコメントの書き方|1行コメントと複数行コメントを初心者向けに解説
プログラムには「コメントを書く派」と「書かない派」がいますが、実務ではコメントがないコードは理解が難しくなることが多いです。特に複雑な処理や後から見返すコードでは、コメントがあるだけで読みやすさが大きく変わります。
このページでは、JavaScriptで使える1行コメントと複数行コメントの書き方を初心者向けにわかりやすく解説します。
JavaScriptのコメントの書き方
JavaScriptでは、次の2種類のコメントが使えます。
- //:その行の後ろがコメントになる(1行コメント)
- /* ~ */:囲んだ部分がコメントになる(複数行コメント)
実際のコード例は次のとおりです。
<head>
<title>JavaScript Sample</title>
<script type=”text/javascript”>
<!–
ここにスクリプトを記述します。
// これは1行コメント
/* これは複数行コメント */
// –>
</script>
</head>
<body>
<script type=”text/javascript”> // JavaScriptは複数記述できる
<!–
ここにスクリプトを記述します。
// –>
</script>
<noscript>このページはJavaScript対応ブラウザで見てください。</noscript>
</body>
</html>
複数行コメントを書くには?
/* ~ */ を使うと、複数行にわたってコメントを書くことができます。
/*
ここに複数行コメントを書けます。
処理の説明や注意点を書くときに便利です。
*/
</script>
複数行コメントは、処理の説明や注意点をまとめて書くときに便利です。
コメントの用途
コメントは実行時に無視され、スクリプトの動作には影響しません。主な用途は次のとおりです。
- コードの説明を残す
- 後から見返したときの理解を助ける
- 一時的にコードを無効化(コメントアウト)して動作確認する
- エラー箇所の切り分けに使う