当你加入到一个项目,相关的CSS文件可能会看得你头昏眼花。时间一长,修改了哪些内容,增加了哪些内容,也都弄不清,维护成本相当的高。正好我们国际站正在进行代码的规范工作。下面的这段代码注释的思路值得借鉴。
通常写法:
#sidebar ul li a {
display: block;
background-color: #ccc;
border-bottom: 1px solid #999;
margin: 3px 0 3px 0;
padding: 3px;
}
注释的代码段:
#sidebar ul li a {
display: block;
background-color: #ccc;
border-bottom: 1px solid #999; /* ADDED Apr. 9, 2008 */
margin: 3px 0 3px 0;
padding: 3px; /* CHANGED Feb. 14, 2008 (Prev. 1px) */
}
上面的代码中,注释了增加代码的时间,修改代码的时间以及修改前的属性值。如果是多人协作,我建议还加上修改者的名称。当然,这样一直写下将带来过多的垃圾代码。需要定期的整理归档,保持文档的时效性。
相关文章
Tags: css



小乌龟SVN show log 就知道谁改了改了哪里,双击列表里的文件就会调用比较工具,这玩意儿超好用
或者开发的时候用这个方法,发布的时候压缩一下去掉所有注释哈
[回复]
SVN确实可以做到。但是这里的注释是给每一个人来看的。有些东西只会在本地测试
[回复]
涛哥,blog风格要换了哦,不符合你特点啊。以前经常出新的风格的。
[回复]
一般这样的注释得需要团队所有人员共同使用 就像形成规定一样
[回复]
这种注释代码有什么意义么?
[回复]
对于一个国际性的网站,加这么多的代码注释,是不是加重了css呢?
下载loading速度。
至于管控,svn vss可以,或者有其它的解决方法。
[回复]
代码注释,只是我们在本地维护用,在发布到正式环境的时候会去掉所有的注释。并且,这个只是我个人的一些想法,而非我们现在的做法 :)
[回复]
好文.
[回复]
我们做项目也用同样的方法,先约定A(add),M(modify),D(delete)来代表所做的操作,日期:yy.mm.dd,人名都用拼音缩写(在设计规范中约定)。然后在css中添加注释,注释起来简单明了
[回复]