今回はHTML言語で使用される「コメントアウト」について説明しようと思います。

「コメントアウト」というのはHTMLファイルに記述されている文言の一部をコメント化することです。

コメント化された文言はHTML言語として機能することは無いのでどんな文言を記述しても問題無いです。

HTMLファイル内にコメントを残すことによって各部分がホームページのどこを描画しているのか、何の書式を設定しているのかといったことが後から見たときにわかりやすくなります。

「コメントアウト」は自分が後から調べる場合や忘れてしまった場合、第3者が見た場合等に分かりやすくするために使用されます。

「コメントアウト」するための書式は下記になります。

<!--と-->で囲む

上記2つの記号に囲まれた文言がコメント化されます。

以前作成したHTMLファイルへコメントの説明文を加えたものを下記に示します。

上記のようにHTMLファイルが何を表しているのかを説明しています。

このような短いHTMLファイルであればコメントは必要ないかもしれないですが、100行とか1000行とかの長文になると、どの部分が何を描画しているのかを後から調べるのが大変になるので、コメントは極力残すことを覚えておいた方が良いと思います。

コメントアウトを使用する際に注意することがいくつか有ります。下記に示します。

①コメントの中にコメントの記号を入れないこと。

②コメントの中に‐（ハイフン）を使用しないこと。

③ソースコード上では表示されてしまうため、ホームページとして公開してしまった場合は不特定多数に見られる。

上記①、②はHTMLの現行のバージョンであればうまくコメント化されるものもあるそうなのですが、極力使用しないようにした方が良いです。

間違ってコメント化されず、ホームページ上に表示されてしまう可能性が有るからです。

③については不特定多数に見られてしまうので、見られて困るような情報は記載しないようにしなければなりません。（パスワード情報や個人情報等）

今回はHTML言語の「コメントアウト」について説明させていただきました。

参考資料

・コメントアウトについて | HTML5入門編 - ウェブプログラミングポータル (wp-p.info)

・HTMLのコメントアウトの書き方・ショートカットと注意点を解説！ ｜パーソルクロステクノロジー (persol-xtech.co.jp)