网页制作过程中代码注释书写规范(2)

注释层级

在模块制作中，可能会出现区域中还有区域的情况，为了更好的区分区域之间的层级，引入了注释层级的概念。

区域注释前面的等号表示了当前注释的层级

例：

<!--=S 注释内容-->
...
  <!--==S 注释内容-->
  ...
    <!--===S 注释内容-->
    ...
    <!--===E 注释内容-->
  ...
  <!--==E 注释内容-->
...
<!--=E 注释内容-->

/*=S 注释内容*/
...
/*==S 注释内容*/
...
/*===S 注释内容*/
...
/*===E 注释内容*/
...
/*==E 注释内容*/
...
/*=E 注释内容*/

协助注释

非作者维护时所加入的表示修改时间、修改人等标识信息。

在区域注释或单行注释的基础上加上修改人和修改时间等信息。

例(区域注释)：

<!--==S 注释内容[修改人和修改时间]-->
<div>
...
</div>
<!--==E 注释内容[修改人和修改时间]-->

/*=S 注释内容[修改人和修改时间]*/
.class{
...
}
.class{
...
}
/*=E 注释内容[修改人和修改时间]*/

例(单行注释)：

<div>
<!-- 注释内容[修改人和修改时间]-->
...
</div>

.class{
/*注释内容[修改人和修改时间]*/
...
}