网络编程
位置:首页>> 网络编程>> 网页设计>> 良好的css代码注释

良好的css代码注释

 来源:Alibaba.com UED 发布时间:2008-07-01 13:02:00 

标签:注释,代码,css

当你加入到一个项目,相关的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) */ 
}

上面的代码中,注释了增加代码的时间,修改代码的时间以及修改前的属性值。如果是多人协作,我建议还加上修改者的名称。当然,这样一直写下将带来过多的垃圾代码。需要定期的整理归档,保持文档的时效性。

0
投稿

猜你喜欢

手机版 网络编程 asp之家 www.aspxhome.com