コメント
HTML のコメントは、マークアップに説明メモを追加したり、文書内の特定の箇所をブラウザーに解釈させないようにしたりするために使用します。
コメントは文字列 <!--
で始まり、文字列 -->
で終わります。通常、その間にはテキストが含まれます。このテキストは文字列 >
または ->
で始めることはできません。また、文字列 -->
または --!>
を含むことも、文字列 <!-
で終わることもできません。ただし、<!
は許可されています。
ブラウザーはコードをレンダリングする際にコメントを無視します。言い換えれば、コメントはページ上には表示されず、コード上にのみ表示されます。HTML コメントは、コードやロジックについて役立つメモを書く方法です。
上記のことは、XML コメントにも当てはまります。さらに XML、例えば SVG や MathML マークアップなどでは、コメントに文字列 --
を格納することはできません。
コメントは単一の行で使用することも、複数行にわたって使用することもできます。コメントは以下の場所で使用することができます。
- doctype の前後
<html>
要素の前後- ほとんどの要素コンテンツ。ただし、
<script>
,<style>
,<title>
,<textarea>
は、コンテンツを生のテキストとして解釈するため不可。
メモ: <script>
要素は HTML コメントを持たず、JavaScript コメントを使用すべきですが、JavaScript に対応していない古いブラウザーではコンテンツがテキストとして表示されないように、スクリプトコンテンツ全体を HTML コメントで囲むという慣習が残っていました。これは現在では JavaScript 自体の古い機能であり、これに頼るべきではありません。
構文
<!-- コメント -->
例
<!-- 1 行コメント -->
<!--
複数行に
展開された
コメント
-->
<!-- 下記のコメントは、内部の
HTML を無効にしている -->
<!--
<p>
このコンテンツは表示されません。
</p>
-->
メモ
HTML コメントはコンテンツとしてのみ許可されています。タグ内、例えば HTML 属性の前に使用することはできません。
<!-- -->
コメント構文を使用するほとんどのプログラミング言語と同様に、コメントはネスト(入れ子)にすることができません。言い換えれば、<!--
の後に出現した最初の -->
が、コメントが閉じられたことを意味します。
コメントは <
で始まり >
で終わりますが、コメントは HTML 要素ではありません。
仕様書
Specification |
---|
HTML Standard # comments |
関連情報
- JavaScript のコメント
- CSS のコメント
Comment
API(Comment
はNode
を継承)