CSS样式表注释书写规范

交友分清对象

交友分清对象

2016-02-19 23:48

今天图老师小编要向大家分享个CSS样式表注释书写规范教程,过程简单易学,相信聪明的你一定能轻松get!

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

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

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

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

例:


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

 

(本文来源于图老师网站,更多请访问https://m.tulaoshi.com/webkaifa/)

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


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

例:


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

 

(本文来源于图老师网站,更多请访问https://m.tulaoshi.com/webkaifa/)

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


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

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

例:


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

 

(本文来源于图老师网站,更多请访问https://m.tulaoshi.com/webkaifa/)

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


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

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

例(区域注释):


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

 

(本文来源于图老师网站,更多请访问https://m.tulaoshi.com/webkaifa/)

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


例(单行注释):


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

 

(本文来源于图老师网站,更多请访问https://m.tulaoshi.com/webkaifa/)

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

(本文来源于图老师网站,更多请访问https://m.tulaoshi.com/webkaifa/)


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

展开更多 50%)
分享

猜你喜欢

CSS样式表注释书写规范

Web开发
CSS样式表注释书写规范

CSS样式表书写顺序

Web开发
CSS样式表书写顺序

s8lol主宰符文怎么配

英雄联盟 网络游戏
s8lol主宰符文怎么配

让样式表CSS代码更加专业规范

Web开发
让样式表CSS代码更加专业规范

[css]简明教程 样式表的书写格式

Html CSS布局 Div+CSS XHTML
[css]简明教程 样式表的书写格式

lol偷钱流符文搭配推荐

英雄联盟 网络游戏
lol偷钱流符文搭配推荐

网页制作 谈谈CSS样式表的命名规范

Web开发
网页制作 谈谈CSS样式表的命名规范

关于CSS样式表

Web开发
关于CSS样式表

lolAD刺客新符文搭配推荐

英雄联盟
lolAD刺客新符文搭配推荐

CSS教程:让IE6支持position:fixed

CSS教程:让IE6支持position:fixed

陪你天崩地裂的经典情侣分组天踏下来有我来顶着

陪你天崩地裂的经典情侣分组天踏下来有我来顶着
下拉加载更多内容 ↓