CSS编码规范

1、前言

CSS指层叠样式表 (Cascading Style Sheets),是网页样式语言。任何网页都离不开CSS样式,作为前端开发工程师也必须要掌握的编程语言,使得在开发过程中,你能随意的更改样式和做页面UI调整,增强界面体验等。 CSS语言掌握情况测试,基础教程

本编码规范目的是使开发人员编写的CSS代码风格保持一致,容易被理解和维护。

2、代码风格

2.1 文件

[强制]自定义CSS 文件请单独创建文件

解释:单独创建文件有利于维护,同时方便ui的样式替换和升级。

[建议]CSS 文件使用无 BOMUTF-8 编码

解释:UTF-8 编码具有更广泛的适应性。BOM在使用程序或工具处理文件时可能造成不必要的干扰。

单独创建CSS文件

2.2 缩进

[建议] 使用4个空格做为一个缩进层级,不允许使用2个空格 或tab字符。
示例:

  1. .map {
  2. margin:0;
  3. padding:0;
  4. }

2.3 空格

[强制] 选择器{ 之间必须包含空格。

示例:

  1. .selector {
  2. }

[强制] 属性名 与之后的 : 之间不允许包含空格, :属性值 之间必须包含空格。

示例:

  1. margin:0;

[强制] 列表型属性值 书写在单行时,, 后必须跟一个空格。

示例:

  1. font-family:Arial, sans-serif;

2.4 行长度

[强制] 每行不得超过 120 个字符,除非单行不可分割。

解释:

常见不可分割的场景为URL超长。

[建议] 对于超长的样式,在样式值的 空格 处或 , 后换行,建议按逻辑分组。

示例:

  1. /* 不同属性值按逻辑分组 */
  2. background:
  3. transparent url(aVeryVeryVeryLongUrlIsPlacedHere)
  4. no-repeat 00;
  5. /* 可重复多次的属性,每次重复一行 */
  6. background-image:
  7. url(aVeryVeryVeryLongUrlIsPlacedHere)
  8. url(anotherVeryVeryVeryLongUrlIsPlacedHere);
  9. /* 类似函数的属性值可以根据函数调用的缩进进行 */
  10. background-image:-webkit-gradient(
  11. linear,
  12. left bottom,
  13. left top,
  14. color-stop(0.04, rgb(88,94,124)),
  15. color-stop(0.52, rgb(115,123,162))
  16. );

2.5 选择器

[强制] 当一个 rule 包含多个 selector 时,每个选择器声明必须独占一行。

示例:

  1. /* good */
  2. .post,
  3. .page,
  4. .comment {
  5. line-height:1.5;
  6. }
  7. /* bad */
  8. .post,.page,.comment {
  9. line-height:1.5;
  10. }

[强制] >+~ 选择器的两边各保留一个空格。

示例:

  1. /* good */
  2. main > nav {
  3. padding:10px;
  4. }
  5. label + input {
  6. margin-left:5px;
  7. }
  8. input:checked~ button {
  9. background-color:#69C;
  10. }
  11. /* bad */
  12. main>nav {
  13. padding:10px;
  14. }
  15. label+input {
  16. margin-left:5px;
  17. }
  18. input:checked~button {
  19. background-color:#69C;
  20. }

[强制] 属性选择器中的值必须用双引号包围。

解释:

不允许使用单引号,不允许不使用引号。

示例:

  1. /* good */
  2. article[character="juliet"]{
  3. voice-family:"Vivien Leigh", victoria, female;
  4. }
  5. /* bad */
  6. article[character='juliet']{
  7. voice-family:"Vivien Leigh", victoria, female;
  8. }

2.6 属性

[强制] 属性定义必须另起一行。

示例:

  1. /* good */
  2. .selector {
  3. margin:0;
  4. padding:0;
  5. }
  6. /* bad */
  7. .selector { margin:0; padding:0;}

[强制] 属性定义后必须以分号结尾。

示例:

  1. /* good */
  2. .selector {
  3. margin:0;
  4. }
  5. /* bad */
  6. .selector {
  7. margin:0
  8. }

说明:以上2.2——2.6 的要求可以通过IDE美化CSS达到。推荐sublime或者webstrom

3 通用

3.1 选择器

[强制] 如无必要,不得为 idclass 选择器添加类型选择器进行限定。

解释:

在性能和维护性上,都有一定的影响。

示例:

  1. /* good */
  2. #error,
  3. .danger-message {
  4. font-color:#c00;
  5. }
  6. /* bad */
  7. dialog#error,
  8. p.danger-message {
  9. font-color:#c00;
  10. }

[建议] 选择器的嵌套层级应不大于 3 级,位置靠后的限定条件应尽可能精确。

示例:

  1. /* good */
  2. #username input {}
  3. .comment .avatar {}
  4. /* bad */
  5. .page .header .login #username input {}
  6. .comment div *{}

3.2 属性缩写

[建议] 在可以使用缩写的情况下,尽量使用属性缩写。

示例:

  1. /* good */
  2. .post {
  3. font:12px/1.5 arial, sans-serif;
  4. }
  5. /* bad */
  6. .post {
  7. font-family: arial, sans-serif;
  8. font-size:12px;
  9. line-height:1.5;
  10. }

[建议] 使用 border / margin / padding 等缩写时,应注意隐含值对实际数值的影响,确实需要设置多个方向的值时才使用缩写。

解释:

border / margin / padding 等缩写会同时设置多个属性的值,容易覆盖不需要覆盖的设定。如某些方向需要继承其他声明的值,则应该分开设置。

示例:

  1. /* centering <article class="page"> horizontally and highlight featured ones */
  2. article {
  3. margin:5px;
  4. border:1px solid #999;
  5. }
  6. /* good */
  7. .page {
  8. margin-right:auto;
  9. margin-left:auto;
  10. }
  11. .featured {
  12. border-color:#69c;
  13. }
  14. /* bad */
  15. .page {
  16. margin:5pxauto;/* introducing redundancy */
  17. }
  18. .featured {
  19. border:1px solid #69c; /* introducing redundancy */
  20. }

3.3 属性书写顺序

[建议] 同一 rule set 下的属性在书写时,应按功能进行分组,并以 Formatting Model(布局方式、位置) > Box Model(尺寸) > Typographic(文本相关) > Visual(视觉效果) 的顺序书写,以提高代码的可读性。

解释:

  • Formatting Model 相关属性包括:position / top / right / bottom / left / float / display / overflow
  • Box Model 相关属性包括:border / margin / padding / width / height
  • Typographic 相关属性包括:font / line-height / text-align / word-wrap
  • Visual 相关属性包括:background / color / transition / list-style

另外,如果包含 content 属性,应放在最前面。

示例:

  1. .sidebar {
  2. /* formatting model: positioning schemes / offsets / z-indexes / display / ... */
  3. position: absolute;
  4. top:50px;
  5. left:0;
  6. overflow-x: hidden;
  7. /* box model: sizes / margins / paddings / borders / ... */
  8. width:200px;
  9. padding:5px;
  10. border:1px solid #ddd;
  11. /* typographic: font / aligns / text styles / ... */
  12. font-size:14px;
  13. line-height:20px;
  14. /* visual: colors / shadows / gradients / ... */
  15. background:#f5f5f5;
  16. color:#333;
  17. -webkit-transition: color 1s;
  18. -moz-transition: color 1s;
  19. transition: color 1s;
  20. }

3.4 清除浮动

[建议] 当元素需要撑起高度以包含内部的浮动元素时,通过对伪类设置 clear 或触发 BFC 的方式进行 clearfix。尽量不使用增加空标签的方式。

解释:

触发 BFC 的方式很多,常见的有:

  • float 非 none
  • position 非 static
  • overflow 非 visible

如希望使用更小副作用的清除浮动方法,参见 A new micro clearfix hack 一文。

另需注意,对已经触发 BFC 的元素不需要再进行 clearfix。

3.5 !important

[建议] 尽量不使用 !important 声明。

[建议] 当需要强制指定样式且不允许任何场景覆盖时,通过标签内联和 !important 定义样式。

解释:

必须注意的是,仅在设计上 确实不允许任何其它场景覆盖样式 时,才使用内联的 !important 样式。通常在第三方环境的应用中使用这种方案。下面的 z-index 章节是其中一个特殊场景的典型样例。

3.6 z-index

[建议] 将 z-index 进行分层,对文档流外绝对定位元素的视觉层级关系进行管理。

解释:

同层的多个元素,如多个由用户输入触发的 Dialog,在该层级内使用相同的 z-index 或递增 z-index

建议每层包含100个 z-index 来容纳足够的元素,如果每层元素较多,可以调整这个数值。

[建议] 在可控环境下,期望显示在最上层的元素,z-index 指定为 999999

解释:

可控环境分成两种,一种是自身产品线环境;还有一种是可能会被其他产品线引用,但是不会被外部第三方的产品引用。

不建议取值为 2147483647。以便于自身产品线被其他产品线引用时,当遇到层级覆盖冲突的情况,留出向上调整的空间。

[建议] 在第三方环境下,期望显示在最上层的元素,通过标签内联和 !important,将 z-index 指定为 2147483647

解释:

第三方环境对于开发者来说完全不可控。在第三方环境下的元素,为了保证元素不被其页面其他样式定义覆盖,需要采用此做法。

4 值与单位

4.1 文本

[强制] 文本内容必须用双引号包围。

解释:

文本类型的内容可能在选择器、属性值等内容中。

示例:

  1. /* good */
  2. html[lang|="zh"] q:before {
  3. font-family:"Microsoft YaHei", sans-serif;
  4. content:"“";
  5. }
  6. html[lang|="zh"] q:after {
  7. font-family:"Microsoft YaHei", sans-serif;
  8. content:"”";
  9. }
  10. /* bad */
  11. html[lang|=zh] q:before {
  12. font-family:'Microsoft YaHei', sans-serif;
  13. content:'“';
  14. }
  15. html[lang|=zh] q:after {
  16. font-family:"Microsoft YaHei", sans-serif;
  17. content:"”";
  18. }

4.2 数值

[强制] 当数值为 0 - 1 之间的小数时,省略整数部分的 0

示例:

  1. /* good */
  2. panel {
  3. opacity:.8;
  4. }
  5. /* bad */
  6. panel {
  7. opacity:0.8;
  8. }

4.3 url()

[强制] url() 函数中的路径不加引号。

示例:

  1. body {
  2. background: url(bg.png);
  3. }

[建议] url() 函数中的绝对路径可省去协议名。

示例:

  1. body {
  2. background: url(//baidu.com/img/bg.png) no-repeat 0 0;
  3. }

4.4 长度

[强制] 长度为 0 时须省略单位。 (也只有长度单位可省)

示例:

  1. /* good */
  2. body {
  3. padding:05px;
  4. }
  5. /* bad */
  6. body {
  7. padding:0px5px;
  8. }

4.5 颜色

[强制] RGB颜色值必须使用十六进制记号形式 #rrggbb。不允许使用 rgb()

解释:

带有alpha的颜色信息可以使用 rgba()。使用 rgba() 时每个逗号后必须保留一个空格。

示例:

  1. /* good */
  2. .success {
  3. box-shadow:002px rgba(0,128,0,.3);
  4. border-color:#008000;
  5. }
  6. /* bad */
  7. .success {
  8. box-shadow:002px rgba(0,128,0,.3);
  9. border-color: rgb(0,128,0);
  10. }

[强制] 颜色值可以缩写时,必须使用缩写形式。

示例:

  1. /* good */
  2. .success {
  3. background-color:#aca;
  4. }
  5. /* bad */
  6. .success {
  7. background-color:#aaccaa;
  8. }

[强制] 颜色值不允许使用命名色值。

示例:

  1. /* good */
  2. .success {
  3. color:#90ee90;
  4. }
  5. /* bad */
  6. .success {
  7. color: lightgreen;
  8. }

[建议] 颜色值中的英文字符采用小写。如不用小写也需要保证同一项目内保持大小写一致。

示例:

  1. /* good */
  2. .success {
  3. background-color:#aca;
  4. color:#90ee90;
  5. }
  6. /* good */
  7. .success {
  8. background-color:#ACA;
  9. color:#90EE90;
  10. }
  11. /* bad */
  12. .success {
  13. background-color:#ACA;
  14. color:#90ee90;
  15. }

4.6 2D 位置

[强制] 必须同时给出水平和垂直方向的位置。

解释:

2D 位置初始值为 0% 0%,但在只有一个方向的值时,另一个方向的值会被解析为 center。为避免理解上的困扰,应同时给出两个方向的值。background-position属性值的定义

示例:

  1. /* good */
  2. body {
  3. background-position: center top;/* 50% 0% */
  4. }
  5. /* bad */
  6. body {
  7. background-position: top;/* 50% 0% */
  8. }

5 文本编排

5.1 字体族

[强制] font-family 属性中的字体族名称应使用字体的英文 Family Name,其中如有空格,须放置在引号中。

解释:

所谓英文 Family Name,为字体文件的一个元数据,常见名称如下:

字体操作系统Family Name
宋体 (中易宋体)WindowsSimSun
黑体 (中易黑体)WindowsSimHei
微软雅黑WindowsMicrosoft YaHei
微软正黑WindowsMicrosoft JhengHei
华文黑体Mac/iOSSTHeiti
冬青黑体Mac/iOSHiragino Sans GB
文泉驿正黑LinuxWenQuanYi Zen Hei
文泉驿微米黑LinuxWenQuanYi Micro Hei

示例:

  1. h1 {
  2. font-family:"Microsoft YaHei";
  3. }

[强制] font-family 按「西文字体在前、中文字体在后」、「效果佳 (质量高/更能满足需求) 的字体在前、效果一般的字体在后」的顺序编写,最后必须指定一个通用字体族( serif / sans-serif )。

解释:

更详细说明可参考本文

示例:

  1. /* Display according to platform */
  2. .article {
  3. font-family:Arial, sans-serif;
  4. }
  5. /* Specific for most platforms */
  6. h1 {
  7. font-family:"Helvetica Neue",Arial,"Hiragino Sans GB","WenQuanYi Micro Hei","Microsoft YaHei", sans-serif;
  8. }

[强制] font-family 不区分大小写,但在同一个项目中,同样的 Family Name 大小写必须统一。

示例:

  1. /* good */
  2. body {
  3. font-family:Arial, sans-serif;
  4. }
  5. h1 {
  6. font-family:Arial,"Microsoft YaHei", sans-serif;
  7. }
  8. /* bad */
  9. body {
  10. font-family: arial, sans-serif;
  11. }
  12. h1 {
  13. font-family:Arial,"Microsoft YaHei", sans-serif;
  14. }

5.2 字号

[强制] 需要在 Windows 平台显示的中文内容,其字号应不小于 12px

解释:

由于 Windows 的字体渲染机制,小于 12px 的文字显示效果极差、难以辨认。

5.3 字体风格

[建议] 需要在 Windows 平台显示的中文内容,不要使用除 normal 外的 font-style。其他平台也应慎用。

解释:

由于中文字体没有 italic 风格的实现,所有浏览器下都会 fallback 到 obilique 实现 (自动拟合为斜体),小字号下 (特别是 Windows 下会在小字号下使用点阵字体的情况下) 显示效果差,造成阅读困难。

5.4 字重

[强制] font-weight 属性必须使用数值方式描述。

解释:

CSS 的字重分 100 – 900 共九档,但目前受字体本身质量和浏览器的限制,实际上支持 400700 两档,分别等价于关键词 normalbold

浏览器本身使用一系列启发式规则来进行匹配,在 <700 时一般匹配字体的 Regular 字重,>=700 时匹配 Bold 字重。

但已有浏览器开始支持 =600 时匹配 Semibold 字重 (见此表),故使用数值描述增加了灵活性,也更简短。

示例:

  1. /* good */
  2. h1 {
  3. font-weight:700;
  4. }
  5. /* bad */
  6. h1 {
  7. font-weight: bold;
  8. }

5.5 行高

[建议] line-height 在定义文本段落时,应使用数值。

解释:

line-height 设置为数值,浏览器会基于当前元素设置的 font-size 进行再次计算。在不同字号的文本段落组合中,能达到较为舒适的行间间隔效果,避免在每个设置了 font-size 都需要设置 line-height

line-height 用于控制垂直居中时,还是应该设置成与容器高度一致。

示例:

  1. .container {
  2. line-height:1.5;
  3. }

6 变换与动画

[强制] 使用 transition 时应指定 transition-property

示例:

  1. /* good */
  2. .box {
  3. transition: color 1s, border-color 1s;
  4. }
  5. /* bad */
  6. .box {
  7. transition: all 1s;
  8. }

[建议] 尽可能在浏览器能高效实现的属性上添加过渡和动画。

解释:

本文,在可能的情况下应选择这样四种变换:

  • transform: translate(npx, npx);
  • transform: scale(n);
  • transform: rotate(ndeg);
  • opacity: 0..1;

典型的,可以使用 translate 来代替 left 作为动画属性。

示例:

  1. /* good */
  2. .box {
  3. transition: transform 1s;
  4. }
  5. .box:hover {
  6. transform: translate(20px);/* move right for 20px */
  7. }
  8. /* bad */
  9. .box {
  10. left:0;
  11. transition: left 1s;
  12. }
  13. .box:hover {
  14. left:20px;/* move right for 20px */
  15. }

7 响应式

[强制] Media Query 不得单独编排,必须与相关的规则一起定义。

示例:

  1. /* Good */
  2. /* header styles */
  3. @media(...){
  4. /* header styles */
  5. }
  6. /* main styles */
  7. @media(...){
  8. /* main styles */
  9. }
  10. /* footer styles */
  11. @media(...){
  12. /* footer styles */
  13. }
  14. /* Bad */
  15. /* header styles */
  16. /* main styles */
  17. /* footer styles */
  18. @media(...){
  19. /* header styles */
  20. /* main styles */
  21. /* footer styles */
  22. }

[强制] Media Query 如果有多个逗号分隔的条件时,应将每个条件放在单独一行中。

示例:

  1. @media
  2. (-webkit-min-device-pixel-ratio:2),/* Webkit-based browsers */
  3. (min--moz-device-pixel-ratio:2),/* Older Firefox browsers (prior to Firefox 16) */
  4. (min-resolution:2dppx),/* The standard way */
  5. (min-resolution:192dpi){/* dppx fallback */
  6. /* Retina-specific stuff here */
  7. }

[建议] 尽可能给出在高分辨率设备 (Retina) 下效果更佳的样式。

8 兼容性

8.1 属性前缀

[强制] 带私有前缀的属性由长到短排列,按冒号位置对齐。

解释:

标准属性放在最后,按冒号对齐方便阅读,也便于在编辑器内进行多行编辑。

示例:

  1. .box {
  2. -webkit-box-sizing: border-box;
  3. -moz-box-sizing: border-box;
  4. box-sizing: border-box;
  5. }

8.2 Hack

[建议] 需要添加 hack 时应尽可能考虑是否可以采用其他方式解决。

解释:

如果能通过合理的 HTML 结构或使用其他的 CSS 定义达到理想的样式,则不应该使用 hack 手段解决问题。通常 hack 会导致维护成本的增加。

[建议] 尽量使用 选择器 hack 处理兼容性,而非 属性 hack

解释:

尽量使用符合 CSS 语法的 selector hack,可以避免一些第三方库无法识别 hack 语法的问题。

示例:

  1. /* IE 7 */
  2. *:first-child + html #header {
  3. margin-top:3px;
  4. padding:5px;
  5. }
  6. /* IE 6 */
  7. * html #header {
  8. margin-top:5px;
  9. padding:4px;
  10. }

[建议] 尽量使用简单的 属性 hack

示例:

  1. .box {
  2. _display:inline;/* fix double margin */
  3. float: left;
  4. margin-left:20px;
  5. }
  6. .container {
  7. overflow: hidden;
  8. *zoom:1;/* triggering hasLayout */
  9. }

8.3 Expression

[强制] 禁止使用CSS表达式 Expression

解释:原因见前端优化篇章