总结了一下自己工作中使用到的注释书写规范，没有什么技术含量，只是用于统一制作方式，方便维护。包含了“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。

大部分同学使用的区域注释的方法，会以“注释内容开始”或“注释内容结束”、“start”或“end”等，相比之下，以“S”或“E”开始可以更快的使用，比如只要写一次开始或结束的注释，然后复制，改下“S”或“E”就可以快速的完成区域的注释。

区域注释

在实际工作中，有时会出现分不清注释应该在标签之上还是标签之下，为了避免这种情况，注释信息统一写在区域标签开始之前和结束之后，并以“S”或“E”开始，表示区域注释的开始或结束。

例：

＜!--=S 注释内容-->
＜div>
...
＜/div>
＜!--=E 注释内容-->

/*=S 注释内容*/
.class{
...
}
.class{
...
}
/*=E 注释内容*/

单行注释

注释信息应写在需注释的内容区域里

例：

＜div>
＜!--注释内容-->
...
＜/div>

.class{
/*注释内容*/
...
}

热门推荐：

黑客的选择：六大数据库攻击手段

管理与维护宽带路由器的十二秘诀

【责任编辑 王凡】