CSS 样式书写规范

关于CSS书写，可能不同团队有各自的规范，可能很多人在写的时候是想到什么就写什么，没有太多约束。

我认为CSS代码规范还是很重要的，尤其在团队配合。

本文是经过总结实践中得出的一套不错的CSS书写规范，希望结合自身需要，发展出一套适合自己的CSS代码规范。

文件顶部注释（推荐使用）

/*

@description: 中文说明

@author: name

@update: name (2016-06-30 15:00)

*/

区块注释

/* Header */

/* Footer */

/* Gallery */

复制代码对一个代码区块注释（可选），将样式语句分区块并在新行中对其注释

相对网页外层重要部分CSS样式命名：

外套 wrap ——————用于最外层

头部 header —————-用于头部

主要内容 main ————用于主体内容（中部）

左侧 main-left ————-左侧布局

右侧 main-right ———–右侧布局

导航条 nav —————–网页菜单导航条

内容 content —————用于网页中部主体

底部 footer —————–用于底部

不建议使用下划线 _ 进行连接

节省操作，输入的时候少按一个 shift 键；

能良好区分 JavaScript 变量命名字符小写；

字符小写

定义的选择器名，属性及属性值的书写皆为小写。

选择器

当一个规则包含多个选择器时，每个选择器独占一行。

、+、~、> 选择器的两边各保留一个空格。

.header > .header-des,
.content ~ .footer {

}

命名短且语义化良好

对于选择器的命名，尽量简洁且具有语义化，不应该出现 g-abc 这种语义模糊的命名。

规则声明块

当规则声明块中有多个样式声明时，每条样式独占一行。

在规则声明块的左大括号 { 前加一个空格。

在样式属性的冒号 : 后面加上一个空格，前面不加空格。

在每条样式后面都以分号 ; 结尾。

规则声明块的右大括号 } 独占一行。

每个规则声明间用空行分隔。

所有最外层引号使用单引号 ’ 。

当一个属性有多个属性值时，以逗号 , 分隔属性值，每个逗号后添加一个空格，当单个属性

值过长时，每个属性值独占一行。

.footer,
.header {
position: relative;
}

.content {
background:
linear-gradient(135deg, deeppink 25%, transparent 25%) -50px 0,
linear-gradient(225deg, deeppink 25%, transparent 25%) -50px 0,
linear-gradient(315deg, deeppink 25%, transparent 25%),
linear-gradient(45deg, deeppink 25%, transparent 25%);
}

.content::before {
content: '';
}

数值与单位

当属性值或颜色参数为 0 - 1 之间的数时，省略小数点前的 0 。

color: rgba(255, 255, 255, .5);

当长度值为 0 时省略单位。

margin: 0 auto；

十六进制的颜色属性值使用小写和尽量简写。

color: #fff；

样式属性顺序

单个样式规则下的属性在书写时，应按功能进行分组，并以 Positioning Model（布局方式、位置） > Box Model（尺寸） > Typographic（文本相关） > Visual（视觉效果） 的顺序书写，提高代码的可读性。

Positioning Model 布局方式、位置，相关属性包括：position / top / right / bottom / left / z-index / display / float /

Box Model 盒模型，相关属性包括：width / height / padding / margin / border / overflow /

Typographic 文本排版，相关属性包括：font / line-height / text-align / word-wrap /

Visual 视觉外观，相关属性包括：color / background / list-style / transform / animation / transition / …

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

示例如下：

.sidebar {
/* formatting model: positioning schemes / offsets / z-indexes / display / ...  */
position: absolute;
top: 50px;
left: 0;
overflow-x: hidden;

/* box model: sizes / margins / paddings / borders / ...  */
width: 200px;
padding: 5px;
border: 1px solid #ddd;

/* typographic: font / aligns / text styles / ... */
font-size: 14px;
line-height: 20px;

/* visual: colors / shadows / gradients / ... */
background: #f5f5f5;
color: #333;
-webkit-transition: color 1s;
-moz-transition: color 1s;
transition: color 1s;
}

合理使用使用引号

当字体名字中间有空格，中文名字体及 Unicode 字符编码表示的中文字体，为了保证兼容性，都建议在字体两端添加单引号或者双引号，防止浏览器解析的时候不认识。

body {
font-family: 'Microsoft YaHei', '黑体-简', '\5b8b\4f53';
}

避免使用 !important

当存在样式覆盖层叠时，如果你发现新定义的一个样式无法覆盖一个旧的样式，只有加上 !important 才能生效时，是因为你新定义的选择器的优先级不够旧样式选择器的优先级高。所以，合理的书写新样式选择器，是完全可以规避一些看似需要使用 !important 的情况的。

代码注释

[b]单行注释

星号与内容之间必须保留一个空格。

/* 表格隔行变色 */

多行注释

星号要一列对齐，星号与内容之间必须保留一个空格。

/**
Sometimes you need to include optional context for the entire component. Do that up  here if it's important enough.
**/

文件注释

文件顶部必须包含文件注释，用 @name 标识文件说明。星号要一列对齐，星号与内容之间必须保留一个空格，标识符冒号与内容之间必须保留一个空格。

/**
* @name: 文件名或模块名
* @description: 文件或模块描述
* @author: author-name(mail-name@domain.com)
*          author-name2(mail-name2@domain.com)
* @update: 2015-04-29 00:02
*/

@description为文件或模块描述。

@update为可选项，建议每次改动都更新一下。

当该业务项目主要由固定的一个或多个人负责时，需要添加@author标识，一方面是尊重劳动成果，另一方面方便在需要时快速定位责任人。

尽量避免使用标签名

在给最里层的标签命名书写样式的时候，我们有两种选择：

<div class="content">
<ul class="content-list">
<li class="item"></li>
<li class="item"></li>
<li class="item"></li>
<li class="item"></li>
</ul>
</div>

.content .content-list li { }

.content .content-list .item { }

基于 CSS 选择器的解析规则（从右向左），建议使用上述第二种 .content .content-list .item { } ，避免使用通用标签名作为选择器的一环可以提高 CSS 匹配性能。

浏览器的排版引擎解析 CSS 是基于从右向左（right-to-left）的规则，这么做是为了使样式规则能够更快地与渲染树上的节点匹配。