コメントを記述する

広告

XML 文書の中で何かメモを残していきたい時はコメントを記述することができます。ここでは XML 文書でコメントを記述する方法について解説します。

コメントを記述する

XML 文書の中でコメントを記述するときの構文は次の通りです。

<!-- コメント -->

コメントは <!-- で始まり --> で終わります。この間にコメントのテキストを記述して下さい。コメントは XML 文書の中のほとんどの場所に記述することができます。

例として次の XML 文書をみてください。

<?xml version="1.0" encoding="UTF-8" ?>
<foods>
  <food>
    <!-- 要在庫確認 -->
    <name>バナナ</name>
    <color>黄色</color>
  </food>

  <food>
    <name>リンゴ</name>
    <!-- 緑っぽい赤 -->
    <color>赤</color>
  </food>
</foods>

この XML 文書をブラウザで表示してみると次のように表示されます。

コメントを記述する(1)

ただし XML 宣言よりも前に記述することはできません。また開始タグや終了タグの中に記述することもできません。次の XML 文書では XML 宣言の前にコメントを書きました。

<!-- 20xx/03 作成 -->
<?xml version="1.0" encoding="UTF-8" ?>
<foods>
  <food>
    <name>バナナ</name>
    <color>黄色</color>
  </food>

  <food>
    <name>リンゴ</name>
    <color>赤</color>
  </food>
</foods>

この XML 文書をブラウザで表示してみると次のように「XML declaration allowed only at the start of the document」というエラーとなりました。

コメントを記述する(2)

またコメントの中に -- を記述することはできません。次の XML 文書をみてください。

<?xml version="1.0" encoding="UTF-8" ?>
<foods>
  <!-- 日本産 -- 愛知県 -->
  <food>
    <name>バナナ</name>
    <color>黄色</color>
  </food>

  <food>
    <name>リンゴ</name>
    <color>赤</color>
  </food>
</foods>

この XML 文書をブラウザで表示してみると次のように「Comment must not contain '--' (double-hyphen)」というエラーとなりました。

コメントを記述する(3)

-- --

XML 文書でコメントを記述する方法について解説しました。

( Written by Tatsuo Ikura )

関連記事 (一部広告含む)
Profile
profile_img

著者 / TATSUO IKURA

初心者~中級者の方を対象としたプログラミング方法や開発環境の構築の解説を行うサイトの運営を行っています。