快速业务通道

CSS样式表注释书写规范

作者 佚名技术 来源 CSS技术 浏览 发布时间 2012-03-03

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

如果大家有其它的建议,欢迎留言。

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

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

例:


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

 

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


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

例:


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

 

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


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

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

例:


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

 

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


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

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

例(区域注释):


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

 

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


例(单行注释):


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

 

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


须要注意注释标记的开始和结束(特别是样式中的单行注释)时,注释内容跟标记间应该加上空格,避免IE下出现读取不到内容的情况。

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务,公司网站:http://www.lingzhong.cn 为了给广大客户了解更多的技术信息,本技术文章收集来源于网络,凌众科技尊重文章作者的版权,如果有涉及你的版权有必要删除你的文章,请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息,谢谢!

分享到: 更多

Copyright ©1999-2011 厦门凌众科技有限公司 厦门优通互联科技开发有限公司 All rights reserved

地址(ADD):厦门软件园二期望海路63号701E(东南融通旁) 邮编(ZIP):361008

电话:0592-5908028 传真:0592-5908039 咨询信箱:web@lingzhong.cn 咨询OICQ:173723134

《中华人民共和国增值电信业务经营许可证》闽B2-20100024  ICP备案:闽ICP备05037997号