CSS注释风格

  一直写东西都是根据按照自己的方式来写,非科班出身也不知道写东西的规范,前几天打算把以前给Discuz做的主题升级到Discuz X3,但是才发现我连自己写的都看不懂。在群内把我的情况说了下并把主题丢到了共享中,让大家看看,哪位可以帮我一起升级下。但是遗憾的是因为以前不知道注释的作用,写的主题文件中连一句注释都没有,想升级基本跟重写一样,还不如重新来一遍呢。都推荐我看下Discuz、Wordpress等完善程序的注释方式,要养成一个良好的注释习惯和代码书写规范。

  在网上查找了一些程序和其他人写的规范,整理了下符合自己的CSS注释风格,感觉下面的这个CSS注释风格还是非常不错的,现在来给大家分享出来。

  1.样式文件注释

/*-------------------------------------------------
|     style.css [The common style]
+--------------------------------------------------
|     Author: Zhang Weilong<vailog@qq.com>
+--------------------------------------------------
|     Upadated: 2012.12.26 22:20pm
+--------------------------------------------------
|     Upadated by: David <i@zhangweilong.com>
+------------------------------------------------*/

  2.公用颜色注释

/*-------------------------------------------------
     + + + C O L O R S + + +
     Background:     #EDEDED
     Text:           #8A8A8A
     Link:           #666666
     Hover link:     #70A737
     Visited link:   #666666
     H1 H2 H3:       #555555
     H4 H5 H6:       #555555
-------------------------------------------------*/

  3.分块整合注释

/*-------------------------------------------------
     Common Styles
-------------------------------------------------*/

body{...}
a{...}
li{...}

/*-------------------------------------------------
     Header Styles
-------------------------------------------------*/
#header{...}
#logo{...}
#header img{...}

/*-------------------------------------------------
     Navigation Styles
-------------------------------------------------*/
#nav{...}
#nav li{...}
#nav a{...}

 

  4.行级特别注释

body{
	font:bold 12px/20px Verdana,Arial,sans-serif;
	-webkit-text-size-adjust:none; /* for chorme */
}

  这组CSS注释风格是自己今天发现自己感觉最好的一种风格注释,其他的Discuz的也非常不错,但是相对与这个感觉还是不够工整。这几天看完其他人写的主题和程序就总结出一句话“要养成一个良好的注释习惯和代码规范”,大家不管是爱好还是以后打算从事相关工作,都要养成这一习惯要不就跟我似的,N久后重新来看下,都不知道自己写的是什么。

最后修改:7年前

共有 1 条评论