HTML评论约定

时间:2009-06-06 18:44:24

标签: naming-conventions comment-conventions html

我需要使用HTML注释来存储特定数据,但我不想使用已存在的注释方案,这些注释方案由 Dreamweaver <!-- #BeginLibraryItem "/File.lbi" --> Frontpage等程序生成

我如何知道哪个评论方案最不成问题,或者至少不像其他现有评论惯例?

PS: 我在评论中被告知双重超赞“ - ”有时会破坏渲染。

2 个答案:

答案 0 :(得分:3)

您至少需要<!-- -->才能发表评论,是的,您应该避免在评论中间插入“ - ”; “ - ”是实际的注释分隔符。除此之外,您可以在其前面添加任何字符串,我认为您会很好 - 例如,<!--JEREMY_RUDD: -->

然而,在评论中存储数据听起来像是一个次优的想法。你能详细说明一下吗?您是否考虑过像JSON这样的东西可能不合适?

答案 1 :(得分:0)

我已经启动了一个标准,受JSDoc和Javadoc的启发:HTMLDoc