CSS样式表注释书写规范

2016-02-19 23:48 1 1 收藏

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

【 tulaoshi.com - Web开发 】

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

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

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

大部分同学使用的区域注释的方法,会以注释内容开始或注释内容结束、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{
/* 注释内容[修改人和修改时间] */
...
}

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


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

来源:https://www.tulaoshi.com/n/20160219/1630665.html

延伸阅读
标签: Web开发
定义LI前面的小点样式  view plaincopy to clipboardprint? 语法:   list-style-type : disc | circle | square | decimal | lower-roman | upper-roman | lower-alpha | upper-alpha | none | armenian | cjk-ideographic | georgian | lower-greek | hebrew | hiragana | hiragana-iroha | katakana | katakana-iroha...
标签: Web开发
类 为了对网页格式的定义更为精确,有必要让相同的选择符也能分类,并能按照不同的类别来进行不同的样式设计。基本格式如下: 选择符.类别名 {属性:值} 类别名将可以在HTML的标识符里引用: 标识符 class=类别名网页内容 实例: <html> <head> <title>CSS例子</title> <style type="t...
    web标准设计网站,过渡的方法主要是采用XHTML+CSS,css样式表是必不可少的。这就要求所有网页设计师必须熟练掌握CSS,如果你以前不常用,那么现在就开始学习吧。要制作符合web标准的网站,不懂CSS是设计不出漂亮的页面的。     事实上,所有表现的地方都需要用CSS来实现。我们以前都习惯用tabl...
在学习中遇到问题可以到 论坛 发贴交流! 本例为CSS入门系列教程,在这一课中我们将学习CSS的样式表,主要学习在学习css之前你应该掌握哪些基础知识,认识CSS以及如何使用CSS,希望能给对网页制作感兴趣的朋友带来帮助~~ CSS入门教程之关于CSS样式表 一.在学习css之前你应该掌握哪些基础知识 1.什么是网页,什么是超文本语言(html)...
    CSS(Cascading Style sheets,层叠样式表)是一种制作网页的新技术,现在已经为大多数的浏览器所支持,成为网页设计必不可少的工具之一。使用CSS能够简化网页的格式代码,加快下载显示的速度,也减少了需要上传的代码数量,尤其是在设计者面对有数百个网页的站点时,大大减少了重复劳动的工作量。 W3C(The World Wide...

经验教程

732

收藏

50
微博分享 QQ分享 QQ空间 手机页面 收藏网站 回到头部