JavaScript内にコメントを書くときのルール

シェアする

  • このエントリーをはてなブックマークに追加
  • 0

あーりーです。

頭の体操として、JavaScriptの勉強をしています。

前回は、JavaScriptはそもそもどこに書くのか?について書きました。

きょうはJavaScript内にコメントを書く方法についてです。

スポンサーリンク

スクリプト内にコメントが書ける

コメントとは、JavaScriptの本文とは別の、メモのようなものです。

コメントを書く意味

コメントは、自分自身の備忘録として書きます。

あとは、他の人がスクリプトを見たときに、わかりやすいようにですね。

コメントの書き方は2種類

JavaScriptにコメントを書く方法は、2種類あります。

1行で書く方法と、複数行で書く方法です。

たとえば、こういうスクリプトがあるとします。

<html>
<head>
<script>
alert("ようこそ!");
</script>
</head>
<body>
</body>
</html>

今はコメントがない状態です。

これにコメントを足してみますね。

1行のコメント

1行のコメントを書くときは、//(2つのスラッシュ)のあとに書きます。

赤い部分がコメントです。

<html>
<head>
<script>
alert("ようこそ!"); //ここがコメントです
</script>
</head>
<body>
</body>
</html>

これが1行のコメントを書くときのやりかたです。

では…

もっと長い、複数行のコメントを書くときはどうでしょう。

やってみます。

複数行のコメント

複数行のコメントを書くときは、 /* と */ で挟んで書きます。

赤い部分がコメントです。

<html>
<head>
<script>
alert("ようこそ!"); 
/*
ここがコメントです
そう、まぎれもなく
ここがコメントなんです
*/
</script>
</head>
<body>
</body>
</html>

これが複数行のコメントを書くときのやりかたです。

コメントが書かれたスクリプトを実行すると…

コメントが書かれたJavaScriptを実行すると、どうなるか。

コメントがないときと比べて、とくに変化はありません。

コメントは、あってもなくてもスクリプトの実行に影響はありません。

コメントは<script>タグ内に書く

1行コメントのときも、複数行コメントのときも、コメントは<script>タグ内に書きます。

<script>タグの外側に書くと丸見え

もしも…

下のように、<script>タグの外側にコメントを書くと、ブラウザで丸見えになってしまいます。

コメントが丸見えになるダメな例

<html>
<head>
<script>
alert("ようこそ!"); 
</script>
/*
ここがコメントです
そう、まぎれもなく
ここがコメントなんです
*/
</head>
<body>
</body>
</html>

以上。

JavaScriptのコメントの書き方についてでした~。

今日はこれで、おしまい。

JavaScriptの記事は、この記事も含めて「初心者のための超わかりやすいJavaScript入門」にまとめてあります。よろしければご覧ください。