コメントの書き方について

Tweet

HTMLのコメント

XHTML文章にはコメントを入れることができます。コメントはブラウザ上に表示されません。コメントは主に運用保守の面から記述されます。何の処理を行っているのか、このような記述をする意図は何なのか等、後でソースコードを見た際に可読性（理解のしやすさ）を高めることは大切なことです。

「<!––」と「––>」で囲んだ範囲がコメントとして扱われます。

HTMLソースコード例

<!-- htmlのコメントです。 -->

<!-- 複数行に渡って記述することも可能です。
     コメント中のHTMLタグ（<p>テスト</p>など）も
     無視されます。
-->

CSSのコメント

CSSでは「/*」と「*/」で囲んだ範囲がコメントとして扱われます。

HTMLソースコード例

/* CSSのコメントです。 */

/* 複数行に渡って
   記述することも可能です。
*/

JavaScriptのコメント

JavaScriptではコメントの記述方法が2通り存在します。

「/*」と「*/」で囲む

「/*」と「*/」で囲んだ範囲がコメントとして扱われます。複数行に渡るコメント化も可能です。

行先頭に「//」と記述する

行の先頭に「//」と記述した場合、その行末までがコメントとして扱われます。

HTMLソースコード例

/* JavaScriptのコメントです。 */

/* 複数行に渡って
   記述することも可能です。
*/

// この形式のコメントは行末まで有効です。