メモ：HTMLのコメントのつけかたなど

HTMLのソース中に書くコメントについて、目にとまったサイトなどをメモしておきます

正しいコメントの書き方をしましょうということで（自戒もふくめて）。コメントについての解説は以下のサイトにて。

• 正しいコメントを書こう
• SGMLの注釈宣言@鳩丸よもやま話
• コメントは正しく書く必要があります - Web標準普及プロジェクト

コメントの中身にハイフン（-）が続いてしまうのはマズいというのはおぼえておきたいと感じました。

鳩丸よもやま話のページには、正しい書き方であっても、ブラウザの独自の判断により正しく認識してくれないケースを「ぶったぶたれた」という例で紹介されています。注釈宣言テストというページがあり、Firefox3でみたところでは、問題なく表示されていました。さて、IE6でみると・・・・・・

Open MagicVox.netさまでは、(X)HTMLの終了タグへのコメントのつけ方を紹介されています。

• HTML の閉じタグへのコメントの付け方 - Open MagicVox.net

これは、なるほどと思いました。少し気になったんですが、それは、HTMLでタグが入れ子になるときが割りとあって、Vicunaテンプレートでもそうですが、タブインデント（スペースでもいいんですけど）を利用して整形などしているときにはどうかな、という部分です。

ま、いらんことで特に意味はないんですが、簡単なXMLでコメントの書き方だけためしてみました。ブラウザで、ドキュメントツリー表示でみたところ、「構造上もコメントの所属が明確」という点については、納得できた気がします。そのあたりは、好みの部分もあってアレですけど。

<?xml version="1.0"?>
<root>
<main>
    <title>hoge hoge
        <!-- description element --><description>hoge^2</description>
    <!-- end title --></title>
<!-- end main --></main>
<!-- end root --></root>

<?xml version="1.0"?>
<root>
  <main>
    <title>hoge hoge
        <!-- description element --><description>hoge^2</description>
    </title><!-- end title -->
  </main><!-- end main -->
</root><!-- end root -->