HTMLにコメントを入れる方法
HTMLに記述した内容を、覚書として残したい時があります。
本ページでは、HTMLにコメントを入れる方法を説明します。
コメントの記述方法
HTMLのコメントは、以下で入れることができます。
【HTMLのコメント】
<!-- コメントです。 -->
<!--と、-->で囲んだ範囲がコメントになります。1行の途中からコメントにすることもできます。
また、以下のように、複数行にまたがることもできます。
【HTMLの複数行にまたがったコメント】
<!-- コメントです。 2行目もコメントです。 -->
途中にタグがあっても、コメントになります。
コメントは、ブラウザ上では表示されませんが、ブラウザでソースを見る(HTML文書そのものを開く)ことができます。その際は、表示されてしまうため、秘密事項などは記述しないようにする必要があります。
なお、HTMLのコメントは入れ子(コメントの中にコメントを入れる)にはできません。
HTMLの内容を書いておく
コメントの使い方の1つは、この要素を何のために使っているのか覚書として記述することです。以下は、例です。
【コメントを覚書として使う例】
<!-- 記事開始 --> <article> 記事を書く。 </article><!-- 記事終了 --> <!-- サイドバー開始 --> <aside> サイドバーの表示 </aside><!-- サイドバー終了 -->
離れた場所にある開始タグと終了タグにコメントを入れておけば、どこで始まってどこで終了するのかが見わけやすくなります。
コメントアウト
コメントは、一時的に削除したいけど元に戻す可能性もあるため消したくない、と言った時にも使えます。これを、コメントアウトと呼びます。以下は、例です。
【コメントアウトの例】
<!-- <div id="sub"> 問題があると疑っている箇所 </div> -->
もし、コメントにしてうまく表示されたのならそのまま消せますし、問題なければコメントを外せばすぐに元に戻せます。