登录论坛 | 注册会员 设为首页 | 收藏本站
当前位置 : 首页>软件学院>程序开发>CSS>正文
 
CSS样式表设计注释书写规范详解

http://www.dbit.cn 2009-1-22 8:24:38  来源:东北IT网  编辑:叶子
 
  总结了一下自己工作中使用到的注释书写规范,没有什么技术含量,只是用于统一制作方式,方便维护。包含了“区域注释”、“单行注释”、“注释层级”和“协助注释”四个部分。

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

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

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

例:



...

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


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

例:



...

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

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

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

例:


...

...

...

...

...

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

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

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

例(区域注释):



...

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

例(单行注释):



...

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

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

 
收藏】【打印】【进入论坛
  相关文章:

·详解CSS样式表与HTML网页的关系
·CSS样式表在网页设计中的4个特性

 
 
 
 
最新文章

中关村艳照门女主角详记录高清组图 
大连护士门大尺度艳照高清组图
iPhone女孩微博爆红 最宝贵东西换iPhon
反恐精英之父内维尔:改变电脑游戏销售
团购网站黎明之前:中国市场惨烈厮杀不
团购鼻祖Groupon中国揭秘:快与慢的商业
Spil Games发布新的品牌形象
1800配置一台主机 不要显示器
联想V360笔记本模特写真
爱国者第四代移动硬盘将面市、低电压保

 
推荐文章
1
2
3
4
5
6
7
8
9
10
iPhone女孩微博爆红 最宝贵东西换
大连护士门大尺度艳照高清组图
中关村艳照门女主角详记录高清组
苹果员工中毒门
宫如敏不雅照疯传 看张馨予韩一菲
深耕市场 永续经营——专访百脑汇
优派专业电子书 让您回家旅途多姿
揭晓百万大奖三星bada魅力绽放中
大明龙权“江湖英雄会”全国PK大
永恒之塔校园达人挑战赛完美落幕
八卦图解 More>>
iPhone女孩微博爆红 最宝贵东西换 大连护士门大尺度艳照高清组图
中关村艳照门女主角详记录高清组 宫如敏不雅照疯传 看张馨予韩一菲