要は HTML で <div id="hoge"> とあった時に、"id=hoge" に対応する閉じタグ </div> はこれですよ、と明示するためのコメントをどのように書くか、というお話。まぁ、コーダーの判り易いように好きに書くのが一番なんでしょうけれど、ちょっと気になったのでメモ。
よくある書き方ですが、2 行目を見ればここから id="box123" の div 要素が始まることは自明なので、わざわざ 1 行目にコメントをつける必要はないように思えます。クラス名が変更になった場合のメンテナンス性のことを考えても。
だいぶスッキリしました。ところでこの HTML の DOM ツリーを考えて、id="box123" のノードを操作(削除や移動)することを考えます。すると 1 行目とセットであるはずの 4 行目のコメントが浮いてしまうことがわかります。
というわけで(?)こうなりました。仮にクラス名/ID が変更になった場合は、その対応する閉じタグ前のコメントを一ヶ所変更するだけでよくなりました。また DOM 構造上もコメントの所属が明確になっています。
とりあえず、これが一番スマートかつ理に適ったコメントかな、と思います。以上です(オチはありません)
寄せられたコメント (全 2 件中、最新 5 件まで表示しています)
コメントは判り易く書くことが一番大事なので、このエントリの方法が常に正解とは限らないです。
まぁ、私なりに保守性だとか可読性を考えると、この方法が一番かなぁと思うだけなのです。
他にこんな書き方はどーよ？とかありましたらコメントかトラバでヨロシクお願いしますm(_ _m)
なんというか、「そうなんだけど、改めて文章で整理されるとなるほどなぁ」とうなずかずには居られないエントリでした。
うなうな。