• 必须以4个有序字符开始:编码为 U+003C LESS-THAN SIGN 的小于号, 编码为 U+0021 EXCLAMATION MARK 的感叹号, 编码为 U+002D HYPHEN-MINUS 横线, 编码为 U+002D HYPHEN-MINUS横线 ,即 “<!—”
  • 在此之后是注释内容,注释的内容有以下限制:
    • 不能以单个 “>” (U+003E) 字符开始
    • 不能以由 “-“(U+002D HYPHEN-MINUS)和 ”>” (U+003E) 组合的字符开始,即 “->”
    • 不能包含两个连续的 U+002D HYPHEN-MINUS 字符,即 “—”
    • 不能以一个 U+002D HYPHEN-MINUS 字符结束,即 “-”
  • 必须以3个有序字符结束:U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS, U+003E GREATER-THAN SIGN,即 “—>”

标准写法:

错误的写法:

  1. <!--->The Wrong Comment Text-->
  2. <!--The--Wrong--Comment Text-->
  3. <!--The Wrong Comment Text--->

参考 www.w3.org

团队约定

注释内容前后各一个空格字符,注释位于要注释代码的上面,单独占一行

推荐:

  1. <div>...</div>

不推荐:

一般用于描述模块的名称以及模块开始与结束的位置

推荐写法:

  1. <!-- S Comment Text A -->
  2. <div class="mod_a">
  3. ...
  4. </div>
  5. <!-- E Comment Text A -->
  6. <!-- S Comment Text B -->
  7. <div class="mod_b">
  8. ...
  9. </div>
  10. <!-- E Comment Text B -->

不推荐写法:

  1. <!-- S Comment Text A -->
  2. <div class="mod_a">
  3. ...
  4. </div>
  5. <!-- E Comment Text A -->
  6. <!-- S Comment Text B -->
  7. ...
  8. </div>
  9. <!-- E Comment Text B -->

当模块注释内再出现模块注释的时候,为了突出主要模块,嵌套模块不再使用

而改用

  1. <!-- S Comment Text A -->
  2. <div class="mod_a">
  3. <div class="mod_b">
  4. ...
  5. </div>
  6. <!-- /mod_b -->
  7. <div class="mod_c">
  8. ...
  9. </div>
  10. <!-- /mod_c -->
  11. </div>