“区域注释”、“单行注释”、“注释层级”、“协助注释”四个部分
大部分人使用的区域注释的地方,会以“注释内容开始”或“注释内容结束”,“start”或“end”等,相比之下,以"S"或“E”开始可以更快的使用,比如只要写一次开始或结束的注释,然后复制,改下“S”或“E”就可以快速的完成区域的注释。
区域注释
在实际工作中,有时会出现分不清注释应该在标签之上还是标签之下,为了避免这种情况,注释信息统一写在区域标签开始之前和结束之后,并以“S”或“E”开始,表示区域注释的开始或结束。
html
<!-- =S 注释内容 -->
<div>dddd</div>
<!-- =E 注释内容 -->
css
/* =S 注释内容 */
.class{
....
}
/* =E 注释内容 */
单行注释
注释信息应写在需注释的内容区域里
<div>
<!-- 注释内容 -->
</div>
/* 注释内容 */
.class{
...
}
注释层级
在模块制作中,可能会出现区域中还有区域的情况,为了更好的区分区域之间的层级,引入了蛛丝层级的概念。
区域注释前面的等号表示了当前的注释的层级
html
<!-- =S 注释内容 -->
...
<!-- ==S 注释内容 -->
...
<!-- ===S 注释内容 -->
...
<!-- ===E 注释内容 -->
...
<!-- ==E 注释内容 -->
...
<!-- =E 注释内容 -->
css
/* =S 注释内容 */
...
/* ==S 注释内容 */
...
/* ===S 蛛丝内容 */
...
/* ===E 注释内容 */
...
/* ==E 注释内容 */
...
/* =E 注释内容 */
协助注释
非作者维护时所加入的表示修改时间,修改人等标识信息
在区域注释活单行注释的基础上加上修改人和修改时间等信息。
例如:区域注释
html
<!-- ==S 注释内容[修改人和修改时间] -->
...
<!-- ==E 注释内容[修改人和修改时间] -->
css
/*=S 注释内容[修改人和修改时间] */
...
/*=E 注释内容[修改人和修改时间] */
例如:单行注释
html
<!--注释内容[修改人和修改时间]-->
css
/* 注释内容[修改人和修改时间] */
另一种参考
/* 注释内容 */
示例
/* ----------文字样式开始---------- */
/* 白色12象素文字 */
.dreamduwhite12px {
color: white;
font-size: 12px;
}
/* 黑色16象素文字 */
.dreamdublack16px {
color: black;
font-size: 16px;
}
/* ----------文字样式结束---------- */