[HTML] 閉じタグへのコメントの付け方

Posted by
ぴろり
Posted at
2008/09/11 14:39
Trackbacks
関連記事 (0)
Comments
コメント (2)
Post Comment
コメントできます
Category
開発メモ カテゴリ

 要は HTML で <div id="hoge"> とあった時に、"id=hoge" に対応する閉じタグ </div> はこれですよ、と明示するためのコメントをどのように書くか、というお話。まぁ、コーダーの判り易いように好きに書くのが一番なんでしょうけれど、ちょっと気になったのでメモ。

この記事を Delicious に追加する   このエントリーをはてなブックマークに追加  

<!-- #box123 -->
<div id="box123">
do something
</div>
<!-- /#box123 -->

 よくある書き方ですが、2 行目を見ればここから id="box123"div 要素が始まることは自明なので、わざわざ 1 行目にコメントをつける必要はないように思えます。クラス名が変更になった場合のメンテナンス性のことを考えても。

<div id="box123">
do something
</div>
<!-- /#box123 -->

 だいぶスッキリしました。ところでこの HTML の DOM ツリーを考えて、id="box123" のノードを操作(削除や移動)することを考えます。すると 1 行目とセットであるはずの 4 行目のコメントが浮いてしまうことがわかります。

<div id="box123">
do something
<!-- #box123 --></div>

 というわけで(?)こうなりました。仮にクラス名/ID が変更になった場合は、その対応する閉じタグ前のコメントを一ヶ所変更するだけでよくなりました。また DOM 構造上もコメントの所属が明確になっています。
 とりあえず、これが一番スマートかつ理に適ったコメントかな、と思います。以上です(オチはありません)

この記事を Delicious に追加する   このエントリーをはてなブックマークに追加  


この記事を読んだ人はこんな記事も読んでいます記事リコメンデーションについて

カバー画像:Mac OS X のフォントを Chicago っぽくする

この記事のアーカイブ

全ての記事 »
2008年
全てのカテゴリ »
電算室 » 開発メモ
全てのタグ »
,

関連記事/トラックバック

関連記事/トラックバックはまだありません

この記事にトラックバックを送るには?

寄せられたコメント (全 2 件中、最新 5 件まで表示しています)

Posted by
ぴろり ◆OLEEi.VOX.ぴろり ◆OLEEi.VOX.
at
2008/09/12 17:00
ID
M/ajdpKI
コメントは判り易く書くことが一番大事なので、このエントリの方法が常に正解とは限らないです。
まぁ、私なりに保守性だとか可読性を考えると、この方法が一番かなぁと思うだけなのです。
他にこんな書き方はどーよ?とかありましたらコメントかトラバでヨロシクお願いしますm(_ _m)
Posted by
てらぽんてらぽん
at
2008/09/11 20:56
ID
LWEhAyow
なんというか、「そうなんだけど、改めて文章で整理されるとなるほどなぁ」とうなずかずには居られないエントリでした。
うなうな。

コメントを投稿する

 
 (必須, 匿名可, 公開, トリップが使えます)
 (必須, 匿名可, 非公開, Gravatar に対応しています)
 (必須)
スパム コメント防止のため「投稿確認」欄に ランダムな数字 CAPTCHAについて を入力してから送信してください。お手数ですがご協力のほど宜しくお願いいたします。