コメントとは?
ブラウザでは表示されない、HTML内で書き込んで置けるメモのことです。
一旦非表示にしておきたい内容や、保守や引継ぎの為に注意書きとして残せるものです。
コメント構文
一行コメント
<!-- コメント -->
複数行コメント
<!--
コメント
複数行も書けます
-->
HTML4.0以降、コメントはハイフンNG
NG構文
<!-- ----- コメント -------------------------------------------------- -->
<!-------- コメント --------------------------------->
コメントアウトの中でハイフン使っちゃダメなの?
コメントの中でハイフン"-"は使用できません。
数年間そうと知らず、ついつい書いてしまっていました……。
HTML2.0ではハイフンを使うことが許されていましたが、HTML4.0以降はハイフン使用を避けるようにと勧告されました。
これはHTMLのもとになったSGMLに由来しているそうです。
A common error is to include a string of hyphens ("---") within a comment. Authors should avoid putting two or more adjacent hyphens inside comments.
W3CによるHTML4.0勧告:3.2.4 Comments の項目
エラーの原因になる可能性があるため、使用を控えるようにとのことですね。
理由として、ハイフンの連続をコメントの終了と解釈するブラウザがあるからなどが挙げられるそうです。
これなら大丈夫
構文
<!-- ========コメント================================================ -->
<!-- ▽▽▽▽コメント▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽▽ -->