コメントを書く人、書かない人って、結構分かれますよね。ただ、私は今まで「一切コメントがなくても簡単に理解できるプログラム」というのには出会ったことがありません(笑)
もちろん、「そもそも複雑なシステムである」「特殊な書き方で見づらい」など原因はさまざまありますが、一切コメントがないのは苦労する場合が多いです。
やっぱり補足として多少のコメントは残してくれてる方がありがたいと感じます。
今回は、そんなコメントの書き方について、記載していきます。
JavaScriptのコメントの書き方は?
JavaScriptでは、その行の「//」より後ろに記述された部分はコメントになります。また、「/*」と「*/」で囲まれた部分もコメントです。
<head>
<title>JavaScript Sample</title>
<script type=”text/javascript”>
<!–
ここにスクリプトを記述します。
// コメント
/* コメント */
//–>
</script>
</head>
<body>
<script type=”text/javascript”> // JavaScriptは複数記述できる
<!–
ここにスクリプトを記述します。
//–>
</script>
<noscript>
<p>このページはJavaScript対応ブラウザで見てください。</p>
</noscript>
</body>
</html>
複数行書くには?
「/*」~「*/」を使用する場合はコメントを複数行にわたって記述できます。
<head>
<title>JavaScript Sample</title>
<script type=”text/javascript”>
<!–
ここにスクリプトを記述します。
//–>
</script>
</head>
<body>
<script type=”text/javascript”> // JavaScriptは複数記述できる
<!–
ここにスクリプトを記述します。
/*
特定の場所に書き出すには<body>タグの中の
書き出したい場所に記述する
*/
//–>
</script>
<noscript>
<p>このページはJavaScript対応ブラウザで見てください。</p>
</noscript>
</body>
</html>
コメントの部分は実行時に無視され、スクリプトの動作に影響を与えます。スクリプトに関する説明を記述したり、エラーの原因と思われる部分をコメントアウトして動作を確認したりするなどの用途で利用されます。