HTMLコメントとは何ですか？どのように使用されますか？
aブラウザでWebページを表示すると、特定のWebページのコードに基づいて、そのソフトウェア（Webブラウザ）が表示している内容を視覚的に表示しています。 ウェブページのソースコードを見ると、段落、見出し、リスト、リンク、画像など、さまざまなHTML要素で構成された文書が表示されます。 これらの要素はすべて、ウェブサイトの表示の一部として訪問者の画面上のブラウザによってレンダリングされる。 人の画面に表示されないHTMLコードの中には、「HTMLコメント」というものがあります。
コメントとは何ですか？
コメントは、HTML、XML、またはCSS内のコードの文字列であり、ブラウザまたはパーサーによって表示または操作されません。 これはコードに書き込まれ、そのコードやコード開発者からの他のフィードバックに関する情報を提供します。
ほとんどのプログラミング言語にはコメントがあります。これらのコメントは、コードの開発者が次の理由の1つまたは2つ以上に共通して使用します。
- 将来的に自分自身を含めて作業しなければならないかもしれない人に、複雑なコードを記述し説明してください！ 彼らは12ヶ月以上後のコード3または6に戻り、何らかの何かをした理由を覚えていないかもしれません。 コメントは、その質問に答えるのに役立ち、そのページを最初に開発したときの心がどこだったかを思い出させることができます。
- コードがいつ編集またはレビューされたかについての詳細を提供する。 これは有用な情報となり、サイトが最後に作業されたときの開発ログのように機能します。
- コードのセクションを削除しますが、後で使用できるようにしておいてください。 これは、サイトのテストやデバッグ中に行われることがよくあります。 サイトに問題があり、それが何を引き起こしているのか分からない場合は、セクションを1つずつコメントアウトして問題を特定し、問題が何であっても解決できるようにしてください。
- コードを扱っている他の開発者とチャット これは、開発中に同時にコードで作業している他の人と詳細を共有する方法として行われる可能性があります。 これらのコメントが純粋に開発の会話である場合は、サイトを起動する前にコードから削除することをお勧めします。
伝統的に、HTMLのコメントは、複雑なテーブル構造の説明からページ自体の内容の有益な発言まで、ほぼすべての要素に使用されています。 コメントはブラウザで表示されないので、HTMLのどこにでもコメントを追加することができ、顧客がサイトを閲覧するときにコメントが何をするか心配する必要はありません。
コメントを書く方法
HTML、XHTML、XMLでコメントを書くのはとても簡単です。 コメントアウトしたいテキストを次のように囲みます。
<！ -そして
- >あなたが見ることができるように、これらのコメントは「記号より小さい」と叫び点と2つのダッシュで始まります。 コメントは2つのダッシュと "より大きい："記号で終わります。これらの文字の間には、コメントの本文を構成したいものを書くことができます。
CSSでは、HTMLではなくCコードのコメントを使用して少し異なります。スラッシュとアスタリスクで始まります。 コメントの終わりにはアスタリスクとそれに続くスラッシュが続きます。
/ *コメント付きテキスト* /コメントは死にかけているアートです
ほとんどのプログラマーは有用なコメントの価値を知っています。 コメント付きコードを使用すると、そのコードをあるチームメンバーから別のメンバーに簡単に転送できます。 コメントは、QAチームがコードをテストするのに役立ちます。なぜなら、開発者は開発者の意図を理解できるからです。 残念なことに、Wordpressのようなウェブサイトオーサリングプラットフォームが普及しているため、あなたのためにHTMLの多くは、すべてではないにしても、選択されたテーマで立ち上げて実行できるので、コメントはウェブチームによって頻繁に使用されることはありません。 これは、コードで直接作業していない場合、ほとんどのビジュアルオーサリングツールではコメントが実際には見えないためです。 たとえば、ウェブページの上部に表示されるのではなく、次のようになります。
<！ - このページは編集しないでください、スクリプトで自動生成されます - >ビジュアルツールには、コメントがあることを示す小さなアイコンが表示されます。 デザイナーがコメントを物理的に開かない場合、彼は決してそれを見ることができない。 また、上記のページの場合、ページを編集してそのコメントがコメントに記載されたスクリプトによって上書きされると問題が発生する可能性があります。
何ができるの？
- 有意義で有用なコメントを書く。 あなたが長すぎたり、有益な情報を含んでいない場合、他の人があなたのコメントを読むことを期待しないでください。
- 開発者は、ページに表示されているコメントを常に確認する必要があります。
- コメントを追加できるオーサリングプログラムが提供するツールを使用します。
- コンテンツ管理を使用して、ページの編集方法を制御します。
あなたがあなたのウェブページを編集する唯一の人でも、コメントが役に立つことがあります。 複雑なページを1年に1度しか編集しない場合は、テーブルの作成方法やCSSの組み込み方法を忘れてしまいます。 コメントは、あなたのために書かれているように、覚えておく必要はありません。
Jennifer Kryninのオリジナル記事。 ジェレミージラール編集：5/5/17