CSS布局教程

基于web标准的网站设计指南

« 关于网页浏览器边界值 »

css代码注释艺术

有些天津网络公司天津网站制作塘沽网站建设设计师认为在CSS代码中添加注释是很件很无聊的事情,只有不熟悉代码的初学者才会做,存在这种想法的人,多数觉得CSS不是纯粹的编程语言,增加注释没有必要。事实上,添加注释对日后代码维护提供了很大的方便。如果在适当的地方增加一些注释,将有助快速了解代码的意图。
CSS注释的语法虽然简单,但它的放置位置和表达方式比较讲究,这里没有固定的模式,不同设计师有个人的注释习惯,我比较习惯于上面的注释方法。具体地说就是:
在代码段前面添加模块功能说明,便于日后了解代码块的功能,代码段可以包含一个或多个样式。 
在每条规则的选择符后大括号的右侧添加该样式的简单说明,关于这个说明应根据情况,如果觉得样式比较容易误解或难理解,加上说明会方便阅读。
在每个声明之后增加属性说明或提示,有时候为了兼容而定义的Hack代码,就应该在属性后提示一下,避免日后阅读时不明白代码的作用。
如果样式表文件格式是每个规则单行书写,可以省略属性说明和样式简介,直接添加模块注释。
需要说明的是,读者不必为每条声明添加注释,也没有必要为每个规则都添加说明,有些代码一看就明白,可以省略注释。代码注释的目的是画龙点睛,辅助阅读;而不是画蛇添足,增加繁琐。为了帮助初学者学习CSS代码,在本书示例中我进行了很详细的注释,有些注释可能比较罗嗦,但为了适合更多初学者的学习,我还是不厌其烦地把注释写得尽可能细点、全点,也请部分读者谅解。在给示例代码增加注释时,一般我坚持的原则是:模块代码(代码段)最好添加注释性说明,并占据一行,每条规则适当点拨,关键属性或补丁声明必须提不,另外,在样式表文件中还应该在文件顶部添加样式表文档说明,在代码中间添加适当设计说明。例如,下面这个样式表文件是W3C官方网站首页主样式表文件。在这个文档中,先对文档进行说明,包括版权信息、样式表文件名称、版本信息、开发时间等。然后是模块说明性注释,在底部代码中还附加有属性提示性注释。

  • 相关文章:

发表评论:

◎欢迎参与讨论,请在这里发表您的看法、交流您的观点。

日历

最新评论及回复

最近发表

Powered By Z-Blog 1.8 Arwen Build 90619

Copyright www.zxh6655.cn. Some Rights Reserved.黑ICP备09093629号