良好的css代码注释

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

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

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

标签:注释,代码,css
0
投稿

猜你喜欢

  • Bootbox将后台JSON数据填充Form表单的实例代码

    2023-08-22 22:01:21
  • django echarts饼图数据动态加载的实例

    2023-02-13 21:12:43
  • 如何在页面中快捷地添加翻页按钮?

    2010-06-26 12:33:00
  • Laravel操作session和cookie的教程详解

    2023-06-01 21:28:50
  • 一篇文章弄懂Python中的内建函数

    2023-01-18 00:36:36
  • MQTT.js 入门使用教程

    2024-04-19 09:57:20
  • pytorch模型部署 pth转onnx的方法

    2022-07-05 03:49:04
  • 关于Python中Inf与Nan的判断问题详解

    2021-10-31 18:56:33
  • 设计的俗化特征

    2010-04-08 16:07:00
  • 78行Python代码实现现微信撤回消息功能

    2021-12-17 17:41:19
  • Mysql常见bug及解决方案超详细讲解

    2024-01-15 17:20:56
  • tensorflow使用指定gpu的方法

    2022-10-23 16:00:31
  • Vue router安装及使用方法解析

    2023-07-02 16:50:00
  • js鼠标事件大全

    2007-08-13 15:56:00
  • 回答XML与HTML的区别

    2007-12-03 10:58:00
  • 透明数据加密(TDE)库的备份和还原

    2024-01-14 04:51:57
  • ASP实例:即时显示当前页面浏览人数

    2008-04-19 22:02:00
  • 两大步骤教您开启MySQL 数据库远程登陆帐号

    2010-09-30 16:42:00
  • Mysql四种分区方式以及组合分区落地实现详解

    2024-01-23 05:05:25
  • PHP 正则判断中文UTF-8或GBK的思路及具体实现

    2024-06-05 09:49:00
  • asp之家 网络编程 m.aspxhome.com