HTML文書のソースコードの中にコメントを入れる

04/28/2021HTML

1. ソースコードの中に入れておくコメント
- 1.1. コメントの利点
2. Recommended books

ソースコードの中に入れておくコメント

/*コメント文の記述*/
<!-- コメント文 -->

コメントの利点

HTMLのソースコードの中には、サイトのコンテンツとして表示されることのない注意書きやメモなどを記述しておくことができます。それがHTMLのコメントです。

一般に、開始タグと終了タグが遠く離れている場合などに、終了タグがどこの開始タグに対応しているのかを示す用途などに使われています。

コメントには任意の文字を入れることができます。ただし、連続したハイフン（－－や－－－－など）は入れられないので注意しましょう。

コメントを記述した一例です。

<!DOCTYPE html>
<html lang="ja">
<head>
<title>コメントの一例</title>
</head>
<body>

<!--ここにコメントを記述します。サイトには表示されません-->

ここの記述はサイトに表示されます。

<!--
ここにもコメントを記述します。それでもサイトには表示されません。
コメントのおかげで内容の確認もしやすくなります。
-->

</body>
</html>

このコメントが便利なのは、自分の記述した内容についての説明を残しておけるところです。

時間が経てば記述の内容や意図を忘れてしまうかもしれません。また、自分に分かっても他人もそうとは限りません。ですから、コメントを残しておけば、記述の内容や意図が伝わりやすくなります。