HTMLにコメントを入れる方法

コードにコメントを入れることで、自分自身やコードが記述されているページで作業をする人への備忘録や注釈として活用することができます。また、まだ完成していない新規機能の部分をテストしたり、編集したりする際に、その部分のコードをコメントタグで囲めば、簡単に無効化することができます。コメントタグの正しい使い方を身につけることで、チーム全体のコーディング作業の効率も向上します。

ステップ

PDF形式でダウンロード

1
コメントを1行挿入する　コメントは、のタグで指定されます。簡単なコメントを挿入して、あとで見た時に、何についてのコードであるのかを把握しやすくしましょう。
```
<html><head><title>コメントのテスト</title></head><body><p>これはウェブサイトです</p></body></html>
```
- コメントタグ自体にスペースを入れないように注意しましょう。例えば、< !-- と入力しても、コメントタグとして機能しません。コメントタグの中には、スペースがいくら入っても構いません。

複雑なコードを説明したい場合、多くのコードを一度に無効にしたい場合は、複数行に渡ってコメント機能を利用することができます。

<html><head><title>コメントのテスト</title></head><body><!-- コメントは任意の長さで記述できます。コメントタグ内に記述した内容は、ページ内のコードに影響を与えません。--><p>これはウェブサイトです</p></body></html>

3
コメント機能を使って、簡単にコードを無効にする　バグの原因を調査している場合や、ページ上で特定のコードが実行されないようにしたい場合は、無効にしたい部分のコードをコメントタグで囲みます。すると、その部分のコードが無効になります。同様に、コメントタグを削除すれば、その部分のコードは有効になります。
```
<html><head><title>コメントのテスト</title></head><body><p>この画像を見てください</p><img src="https://ja.wikihow.com/images/image1.jpg"></body></html>
```
4
コメント機能を利用して、スクリプト非対応のブラウザでスクリプトが表示されないようにする　JavaScriptやVBScriptでプログラミングをしているならば、コメント機能を利用して、スクリプト非対応のブラウザではスクリプトを無効化することができます。スクリプトの始めにコメントを挿入し、終わりには//-->を挿入すると、囲った部分のスクリプトは、スクリプト対応ブラウザでは動作します。
```
<html><head><title>VBScript</title></head><body><script language="vbscript" type="text/vbscript"></script></body></html>
```
^{[1]X出典文献}
- ブラウザがスクリプトに対応している場合は、終わりにある //タグによって、スクリプトがコメント機能を実行しません。
広告