naming-conventions - HTMLコメント規則

Question

特定のデータを格納するためにHTMLコメントを使用する必要がありますが、 Dreamweaver <!-- #BeginLibraryItem "/File.lbi" -->やFrontpageなどのプログラムによって生成された既存のコメントスキームは使用したくありません。

どのコメントスキームが最も問題が少ないか、または少なくとも他の既存のコメント規則のように見えないかをどうやって知ることができますか？

PS：コメントの二重ハイフン「-」はレンダリングを壊すことがあると言われています。

Answer 1

少なくとも<!-- -->コメントが必要です。もちろん、コメントの途中に「-」を含めることは避けてください。「-」は実際のコメント区切り文字です。それ以外は、任意の文字列をプレフィックスとして付けることができます。たとえば、<!--JEREMY_RUDD: -->。

However, storing data in comments sounds like a suboptimal idea. Can you elaborate on this? Have you considered whether, say, something like JSON might not be more appropriate?

Answer 2

JSDocとJavadocに触発された標準HTMLDocを開始しました。