HTML

コメント（注釈）を挿入する

　HTML文書には任意のコメント（注釈）を入れることができます。コメントは、ブラウザには表示されない内容であり、“作成者にとって” わかりやすい HTML文書を書くために、改行やインデントで要素の関係を明確にするとともに、必要な部分にはコメントという形で、目印やメモ書き、覚え書きとして残しておくことも有益です。自分の覚え書きとして記述するほか、JavaScriptやスタイルシートの記述にも使用されます。

　ソースが長くなると内容を区別しにくく感じることがあると思います。この場合、たとえば「ここからここまでは○○の内容」といったコメントを入れることで、他の内容と視覚的に区別がつけやすくなります。

<!--グローバルナビゲーション　ここから-->
　：
　：
<!--グローバルナビゲーション　ここまで-->

　コメント（注釈）は複数行にわたることもできます。特に目立たせたいコメントについては複数行で記述するとよいでしょう。

<!--グローバルナビゲーション
                           　ここから-->
 　：
 　：
<!--グローバルナビゲーション
                           　ここまで-->

　コメント（注釈）は「タグ」ではありません。SGMLでいうところの「宣言」の一種です。よって、テキストをコメント化するには、SGMLの書式に従って、「<!--」で始まり、次に「-->」が現れるまでの範囲をコメントとして扱い、Webブラウザはその内容を無視し、画面には表示されません。コメント内部「<!--」と「-->」の間に２つ以上連続する「-」（ハイフン）、特に「--」（二重ハイフン）を使うことが禁止されています。

　コメント（注釈）の記号は間違えやすくあらゆるパターンでのミスが多いようです。ミスパターンを書くと誤って覚える可能性があるのでここでは書きません。幸か不幸か、Netscape Communicatorや Internet Explorerでは、間違った書式のコメントも適当に解釈してくれますが、HTMLを正確に解釈する Webブラウザでは、コメントが画面に表示されたり、コメント以降の文字や画像が表示されなくなってしまいます。

　また、HTMLソースの中でセクションを区切る自分用の目印が欲しいときに、コメントを使って「-」（ハイフン）で区切りたくなりますが、コメントの内部には２つ以上連続する「-」（ハイフン）を入れてはいけないので

<!--===========================================-->

のような、「=」を連ねたコメントにしておくのが良さそうです。

　コメント内に「タグ」を書き込むことは禁止されていませんので、たとえば確認のとれていないリンクなどを一時的に

<!-- <a href="https://www.yugien.xyz/">Yugien</a> -->

として隠すことは一応可能ではありますが、これはブラウザによっては正しく解釈されず、（タグを閉じる「>」をコメント終了サインと勘違いする場合がある）途中から表示されてしまうこともあるので、使わない方が無難でしょう。

style要素と script要素の内容のコメント化

　HTMLでは、古いブラウザが CSSや JavaScriptの内容をそのままページ上に表示しないためにコメント化するのが一般的である（JavaScriptの内容をコメント化するには、終了部分で JavaScriptのコメント形式である「//」と併用する）。

　なお、ブラウザによってはコメント化する書式をサポートしていない場合があるので、内容自体を外部ファイル化するのが最もよい方法である。