资讯专栏INFORMATION COLUMN

编写灵活、稳定、高质量的CSS代码的规范

psychola / 1311人阅读

摘要:过度使用简写形式的属性声明会导致代码混乱,并且会对属性值带来不必要的覆盖从而引起意外的副作用。只有在必要的时候才将限制在最近的父元素内也就是后代选择器例如,不使用带前缀的时前缀类似于命名空间。制定一致的注释规范。

一、语法 1.1 注意

(1)用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法。

(2)为选择器分组时,将多带带的选择器多带带放在一行

(3)为了代码的易读性,在每个声明块的左花括号前添加一个空格

(4)声明块的右花括号应当多带带成行

(5)每条声明语句之后应该插入一个空格

(6)为了获得更准确的错误报告,每条声明都应该独占一行

(7)所有声明语句都应当以分号结尾。最后一条声明语句后面的分号是可选的,但是,如果省略这个分号,你的代码可能更易出错。

(8)对于以逗号分隔的属性值,每个逗号后面都应该插入一个空格(例如 ,box-shadow)。

(9)不要在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的内部的逗号后面插入空格。这样利于从多个属性值(既加逗号也加空格)中区分多个颜色值(只加逗号,不加空格)。

(10)对于属性值或颜色参数,省略小于 1 的小数前面的 0 (例如,.5 代替 0.5;-.5px 代替 -0.5px)。

(11)十六进制值应该全部小写,例如,#fff。在扫描文档时,小写字符易于分辨,因为他们的形式更易于区分。

(12)尽量使用简写形式的十六进制值,例如,用 #fff 代替 #ffffff。

(13)为选择器中的属性添加双引号,例如,input[type="text"]。只有在某些情况下是可选的,但是,为了代码的一致性,建议都加上双引号。

(14)避免为 0 值指定单位,例如,用 margin: 0; 代替 margin: 0px;。

1.2 Example

二、声明顺序 2.1 相关属性一组

相关的属性声明应当归为一组,并按照下面的顺序排列:

(1)Positioning

(2)Box model

(3)Typographic

(4)Visual

2.2 说明

(1)由于定位(positioning)可以从正常的文档流中移除元素,并且还能覆盖盒模型(box model)相关的样式,因此排在首位。

(2)盒模型排在第二位,因为它决定了组件的尺寸和位置。

(3)其他属性只是影响组件的内部(inside)或者是不影响前两组属性,因此排在后面。

2.3 Example

三、不要使用 @import 3.1 不用原因

标签相比,@import 指令要慢很多,不光增加了额外的请求次数,还会导致不可预料的问题。

3.2替代方法

(1)使用多个 元素

(2)通过 Sass 或 Less 类似的 CSS 预处理器将多个 CSS 文件编译为一个文件

(3)通过 Rails、Jekyll 或其他系统中提供过 CSS 文件合并功能

3.3 Example

四、媒体查询(Media query)的位置 4.1 相关规则附近

将媒体查询放在尽可能相关规则的附近。不要将他们打包放在一个单一样式文件中或者放在文档底部。如果你把他们分开了,将来只会被大家遗忘。

4.2 Example

五、带前缀的属性 5.1 垂直对齐

当使用特定厂商的带有前缀的属性时,通过缩进的方式,让每个属性的值在垂直方向对齐,这样便于多行编辑。

5.2 Example

六、单行规则声明 6.1 放在一行

对于只包含一条声明的样式,为了易读性和便于快速编辑,建议将语句放在同一行。对于带有多条声明的样式,还是应当将声明分为多行。

6.2 错误检测

这样做的关键因素是为了错误检测 -- 例如,CSS 校验器指出在 100 行有语法错误。如果是单行单条声明,你就不会忽略这个错误;如果是单行多条声明的话,你就要仔细分析避免漏掉错误了。

6.3 Example

七、简写形式的属性声明 7.1 滥用简写

在需要显示地设置所有值的情况下,应当尽量限制使用简写形式的属性声明。常见的滥用简写属性声明的情况如下:

(1)padding

(2)margin

(3)font

(4)background

(5)border

(5)border-radius

7.2 说明

大部分情况下,我们不需要为简写形式的属性声明指定所有值。例如,HTML 的 heading 元素只需要设置上、下边距(margin)的值,因此,在必要的时候,只需覆盖这两个值就可以。过度使用简写形式的属性声明会导致代码混乱,并且会对属性值带来不必要的覆盖从而引起意外的副作用。

7.3 Example

八、Less 和 Sass 中的嵌套 8.1 尽量不嵌套

避免不必要的嵌套。这是因为虽然你可以使用嵌套,但是并不意味着应该使用嵌套。只有在必须将样式限制在父元素内(也就是后代选择器),并且存在多个需要嵌套的元素时才使用嵌套

8.2 Example

九、Less 和 Sass 中的操作符

为了提高可读性,在圆括号中的数学计算表达式的数值、变量和操作符之间均添加一个空格

十、注释 10.1 注意

代码是由人编写并维护的。请确保你的代码能够自描述、注释良好并且易于他人理解。好的代码注释能够传达上下文关系和代码目的。不要简单地重申组件或 class 名称。

对于较长的注释,务必书写完整的句子;对于一般性注解,可以书写简洁的短语。

10.2 Example

十一、class 命名 11.1 规范

(1)class 名称中只能出现小写字符和破折号(dashe)(不是下划线,也不是驼峰命名法)。破折号应当用于相关 class 的命名(类似于命名空间)(例如,.btn 和 .btn-danger)。

(2)避免过度任意的简写。.btn 代表 button,但是 .s 不能表达任何意思。

(3)class 名称应当尽可能短,并且意义明确。

(4)使用有意义的名称。使用有组织的或目的明确的名称,不要使用表现形式(presentational)的名称。

(5)基于最近的父 class 或基本(base) class 作为新 class 的前缀

(6)使用 .js-* class 来标识行为(与样式相对),并且不要将这些 class 包含到 CSS 文件中。

在为 Sass 和 Less 变量命名时也可以参考上面列出的各项规范。

11.2 Example

十二、选择器 12.1 注意

(1)对于通用元素使用 class ,这样利于渲染性能的优化。

(2)对于经常出现的组件,避免使用属性选择器(例如,[class^="..."])。浏览器的性能会受到这些因素的影响。

(3)选择器要尽可能短,并且尽量限制组成选择器的元素个数,建议不要超过 3 。

(4)只有在必要的时候才将 class 限制在最近的父元素内(也就是后代选择器)(例如,不使用带前缀的 class 时 -- 前缀类似于命名空间)。

12.2 Example

十三、代码组织 13.1 注意

(1)以组件为单位组织代码段。

(2)制定一致的注释规范。

(3)使用一致的空白符将代码分隔成块,这样利于扫描较大的文档。

(4)如果使用了多个 CSS 文件,将其按照组件而非页面的形式分拆,因为页面会被重组,而组件只会被移动。

13.2 Example

十四、编辑器配置 14.1 避免代码不同

将你的编辑器按照下面的配置进行设置,以避免常见的代码不一致和差异:

(1)用两个空格代替制表符(soft-tab 即用空格代表 tab 符)。

(2)保存文件时,删除尾部的空白符

(3)设置文件编码为 UTF-8

(4)在文件结尾添加一个空白行

阅读更多

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/115898.html

相关文章

  • 编写灵活稳定质量HTML代码规范

    摘要:六字符编码通过明确声明字符编码,能够确保浏览器快速并容易的判断页面内容的渲染方式。十一减少标签的数量编写代码时,尽量避免多余的父元素。未完待续编写灵活稳定高质量的代码的规范阅读更多 一、唯一定律 无论有多少人共同参与同一项目,一定要确保每一行代码都像是唯一个人编写的。 二、HTML 2.1 语法 (1)用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法...

    anquan 评论0 收藏0
  • 编码规范 —— 编写灵活稳定质量 HTML 和 CSS 代码规范

    摘要:用两个空格代替制表符这是唯一能保证在所有环境下获得一致展现的方法。编辑器配置将你的编辑器按照下面的配置进行设置,以免常见的代码不一致和差异用两个空格代替制表符保存文件时删除尾部的空白符设置文件编码为在文件结尾添加一个空白行。 黄金定律 永远遵循同一套编码规范 - 可以是这里列出的,也可以是你自己总结的。如果发现规范中有任何错误,敬请指正。 HTML 语法 用两个空格代替制表符 (ta...

    Karuru 评论0 收藏0
  • ESLint 在中大型团队应用实践

    摘要:自动化接入和升级方案通过命令行工具提供一键接入升级能力,同时集成到团队脚手架中,大大降低了工程接入和维护的成本。原始代码经过解析器的解析,在管道中逐一经过所有规则的检查,最终检测出所有不符合规范的代码,并输出为报告。 引言 代码规范是软件开发领域经久不衰的话题,几乎所有工程师在开发过程中都会遇到,并或多或少会思考过这一问题。随着前端应用的大型化和复杂化,越来越多的前端工程师和团队开始重...

    alogy 评论0 收藏0
  • 斗米客户端架构思想

    摘要:经过这些年在端浏览器内核端研发经验的积累,年我在斗米的客户端产品上首次提出了以驱动的客户端平台化架构思想,并经过两年时间多个产品的探索实践,我认为该端的架构思想可正式对外分享。在斗米的各客户端中,在不需要发版的前提下,可以使用发版。 背景 随着移动互联网产业的兴起,各式App层出不穷,技术方案多种多样。同样,我们也面临了各式各样的问题,比如产品如何开发能够更快速迭代上线,如何使运营推广...

    Cympros 评论0 收藏0
  • 斗米客户端架构思想

    摘要:经过这些年在端浏览器内核端研发经验的积累,年我在斗米的客户端产品上首次提出了以驱动的客户端平台化架构思想,并经过两年时间多个产品的探索实践,我认为该端的架构思想可正式对外分享。在斗米的各客户端中,在不需要发版的前提下,可以使用发版。 背景 随着移动互联网产业的兴起,各式App层出不穷,技术方案多种多样。同样,我们也面临了各式各样的问题,比如产品如何开发能够更快速迭代上线,如何使运营推广...

    lpjustdoit 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<