JavaScript
 Computer >> コンピューター >  >> プログラミング >> JavaScript

JavaScriptのコードにHTMLコメントを書く必要はある?現代における正しい記述方法

結論:HTMLコメントは不要です

JavaScriptのコードブロック内にHTMLコメント(<!-- -->)を記述する必要はありません。これは1990年代に使われていた過去の慣習であり、当時のようなコメントでコードを隠すことを求めていたブラウザは、現在では存在しません。

なぜかつてHTMLコメントが使われていたのか

1990年代後半には、<script>タグを認識できないブラウザ(Netscape Navigator 1.0やMosaicなど)がまだ存在していました。こうしたブラウザはスクリプトコードをそのままページ上のテキストとして表示してしまうため、開発者は次のようにコードをHTMLコメントで囲んで隠すのが一般的でした。

<script type="text/javascript">
<!--
  // ここにJavaScriptコードを記述
//-->
</script>

しかし、現在すべての主要ブラウザはJavaScriptを正しく解釈できるため、この手法は完全に時代遅れとなっています。むしろ不要なコードが増え、可読性を下げるだけなので、今日の開発では書くべきではありません。

XHTML文書ではCDATAセクションを使う

XMLやXHTMLとして扱われる文書では、代わりにCDATAセクションを使用する方法があります。CDATAセクション内では、<& などの特殊文字がXMLパーサーによって解釈されなくなります。

<script charset="utf-8">
  /* <![CDATA[ */
  // ここにJavaScriptコードを記述
  /* ]]> */
</script>

このように /* */ というJavaScriptのコメントでCDATAの開始・終了タグを囲むことで、HTMLとして解析する場合にもXHTML(XML)として解析する場合にも対応できます。

まとめ

  • HTML5が標準の現在、<script>内にHTMLコメントを書く必要はまったくありません。
  • CDATAセクションも、XHTMLをXMLとして配信する特殊なケース以外ではほぼ不要です。
  • シンプルに <script> タグの中へ直接JavaScriptコードを書けば問題ありません。
  1. JavaScriptでボタンをクリックしたらテキストフィールドを空にする方法

    Web開発では、ボタンをクリックしたタイミングでテキストフィールド(テキストボックス)の中身を空にしたいケースがよくあります。たとえば、検索条件のリセットやフォーム入力内容の初期化などが代表例です。この記事では、JavaScriptを使ってこの処理をシンプルに実現する方法を解説します。 基本の考え方 実装に必要なのは、次の2つのステップだけです。 HTML側でonclick属性を使い、ボタンクリック時に呼び出すJavaScriptの関数を指定する 関数内でdocument.getElementById()によって対象の要素を取得し、そのvalueプロパティに空文字列()を代入する docu

  2. HTMLコメントの書き方を解説!単一行コメントと複数行コメントの基本

    HTMLコメントは、<!-- ... -->タグの間に記述します。このタグ内に書かれた内容はすべてコメントとして扱われ、ブラウザには完全に無視されるため、画面上には表示されません。 HTMLにおける単一行コメント HTMLでは、コードの説明やメモを残したいときにコメント機能を活用できます。まずは、単一行コメントの基本的な例を見てみましょう。 サンプルコード <!DOCTYPE html> <html> <head> <!-- ドキュメントヘッダーの開始 --> <title>これはドキュメントのタイトルです</tit