注释规范

遵循标准

HTML注释规范写法应该遵循以下标准：

Comments must start with the four character sequence U+003C LESS-THAN SIGN, U+0021 EXCLAMATION MARK, U+002D HYPHEN-MINUS, U+002D HYPHEN-MINUS ().

• 必须以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，即 “—>”

标准写法：

<!--Comment Text-->

错误的写法：

<!-->The Wrong Comment Text-->
<!--->The Wrong Comment Text-->
<!--The--Wrong--Comment Text-->
<!--The Wrong Comment Text--->

参考 www.w3.org #Comments

团队约定

单行注释

一般用于简单的描述，如某些状态描述、属性描述等

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

推荐：

<!-- Comment Text -->
<div>...</div>

不推荐：

<div>...</div><!-- Comment Text -->    
<div><!-- Comment Text -->
    ...
</div>

模块注释

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

注释内容前后各一个空格字符，<!-- S Comment Text --> 表示模块开始，<!-- E Comment Text --> 表示模块结束，模块与模块之间相隔一行

推荐写法：

<!-- #region A -->    
<div class="mod_a">
    ...
</div>
<!-- #regionend A -->
<!-- #region B -->    
<div class="mod_b">
    ...
</div>
<!-- #regionend B -->

不推荐写法：

<!-- #region A -->    
<div class="mod_a">
    ...
</div>
<!-- #regionend A -->
<!-- #region B -->    
<div class="mod_b">
    ...
</div>
<!-- #regionend B -->

嵌套模块注释

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

<!-- region Comment Text -->
<!-- regionend Comment Text -->

而改用

<!-- comment Text -->

注释写在模块结尾标签顶部，单独一行。

<!-- region Comment Text A -->
<div class="mod_a">
    <!-- mod_b -->
    <div class="mod_b">
        ...
    </div>
    <!-- mod_c -->
    <div class="mod_c">
        ...
    </div>
</div>
<!-- regionend Comment Text A -->