コメントの挿入方法

コメント宣言(<!-- -->)を使用すると、文書内にコメントを挿入することができます。

<!-- これはコメントです -->

<!--
これは
複数行にまたがる
コメントです。
-->

<!----> で囲まれた部分は、ブラウザ上には表示されません。

コメントの用途

例えば、作者用の覚え書きや、ソースコード内の目印として使用すると便利です。

<!-- お知らせ開始 -->
<h3>お知らせ</h3>
<dl>
<dt>2008年12月20日</dt><dd>商品の一覧を更新しました。</dd>
<dt>2008年12月15日</dt><dd>トピックスのページを更新しました。</dd>
<dt>2008年12月10日</dt><dd>スタッフの募集を開始しました。</dd>
</dl>
<!-- お知らせ終了 -->

また、特定の要素を非表示にしておきたい場合にも使用できます。

<!--
一時的に表示しない
<p><img src="example.gif" alt="サンプル"></p>
<p>要素をコメントアウトすることもできます。</p>
-->

コメント宣言の詳細

コメント宣言は次のパーツで構成されています。

<!--この部分がコメント-->
  • <! … コメント宣言開始
  • -- … コメント開始
  • この部分がコメント … コメントの内容
  • -- … コメント終了
  • > … コメント宣言終了

注意点

  • コメント宣言開始( <! )とコメント開始( -- )の間には、スペースや改行などを入れることはできません。そのままの形( <!-- )で記述する必要があります。
  • コメント終了( -- )とコメント宣言終了( > )の間には、スペースや改行を入れることができます。しかし、ブラウザによっては不具合が発生する場合があるので、こちらもそのままの形( --> )で記述しておくことをお勧めします。
  • コメントの内容には、2つ以上連続するハイフンは含めないようにします(コメント終了とみなされてしまう場合があるので)。コメント内に線を引きたい場合は、等号( = )などを使用するといいでしょう。

コメント内のタグについて

コメント内にタグを記述すると、ブラウザによっては誤った解釈をしてしまう(>をコメント宣言の終了とみなしてしまう)場合があるので注意が必要です。

具体的には次のような例が挙げられます。

<!--<p>ここがコメント</p>-->

<!--<p>ここがコメント</p>-- >

上記のように記述された文書にIEでアクセスすると、1つ目のコメントは正常に解釈されますが、2つ目のコメントはブラウザ上に表示されてしまいます。(p開始タグの > をコメント宣言の終了と解釈してしまうようです)

  • FirefoxやOperaではこの不具合は発生しません。

コメント内にタグを記述する場合は、コメント終了( -- )とコメント宣言終了( > )の間には、スペースや改行を入れないようにした方がいいでしょう。