您的位置：首页 > Web前端 > CSS

前端css编码规范

2015-11-29 10:05 337 查看


网易前端CSS编码规范

css

CSS2

CSS3

Web前端

前端技术

编码规范


为什么需要编码规范

你是否常常碰到以下问题：你总是看不懂他写的代码，或者读起来很吃力；你需要改他的代码却无从下

手，或总是要去问他这里是什么改了会不会影响其他代码；你和他一起开发一个产品，你总是怕代码和他

有冲突或互相影响；你的代码在多次维护任务之后变得越来越臃肿，越来越难以维护。

解决以上问题只需一种方法—-读我们的规范！


分类方法


CSS文件的分类和引用顺序

通常，一个项目我们只引用一个CSS，但是对于较大的项目，我们需要把CSS文件进行分类。

我们按照CSS的性质和用途，将CSS文件分成“公共型样式”、“特殊型样式”、“皮肤型样式”，并以此顺序引用（按需求决定是否添加版本号）。

公共型样式：包括了以下几个部分：“标签的重置和设置默认值”、“统一调用背景图和清除浮动或其他需统一处理的长样式”、“网站通用布局”、“通用模块和其扩展”、“元件和其扩展”、“功能类样式”、“皮肤类样式”。

特殊型样式：当某个栏目或页面的样式与网站整体差异较大或者维护率较高时，

可以独立引用一个样式：“特殊的布局、模块和元件及扩展”、“特殊的功能、颜色和背景”，也可以是某个大型控件或模块的独立样式。

皮肤型样式：如果产品需要换肤功能，那么我们需要将颜色、背景等抽离出来放在这里。

1
2
3

<link href="assets/css/global.css" rel="stylesheet" type="text/css">
<link href="assets/css/index.css" rel="stylesheet" type="text/css">
<link href="assets/css/skin.css" rel="stylesheet" type="text/css">


CSS内部的分类及其顺序

重置（reset）和默认（base）（tags）：消除默认样式和浏览器差异，并设置部分标签的初始样式，以减少后面的重复劳动！你可以根据你的网站需求设置！

统一处理：建议在这个位置统一调用背景图（这里指多个布局或模块或元件共用的图）和清除浮动（这里指通用性较高的布局、模块、元件内的清除）等统一设置处理的样式！

布局（grid）（.g-）：将页面分割为几个大块，通常有头部、主体、主栏、侧栏、尾部等！

模块（module）（.m-）：通常是一个语义化的可以重复使用的较大的整体！比如导航、登录、注册、各种列表、评论、搜索等！

元件（unit）（.u-）：通常是一个不可再分的较为小巧的个体，通常被重复用于各种模块中！比如按钮、输入框、loading、图标等！

功能（function）（.f-）：为方便一些常用样式的使用，我们将这些使用率较高的样式剥离出来，按需使用，通常这些选择器具有固定样式表现，比如清除浮动等！不可滥用！

皮肤（skin）（.s-）：如果你需要把皮肤型的样式抽离出来，通常为文字色、背景色（图）、边框色等，非换肤型网站通常只提取文字色！非换肤型网站不可滥用此类！

功能类和皮肤类样式为表现化的样式，请不要滥用！以上顺序可以按需求适当调整。


命名规则


使用类选择器，放弃ID选择器

ID在一个页面中的唯一性导致了如果以ID为选择器来写CSS，就无法重用。


分类的命名方法：使用单个字母+”-“为前缀

布局（grid）（.g-）；模块（module）（.m-）；元件（unit）（.u-）；功能（function）（.f-）；皮肤（skin）（.s-）。

详情参见：分类方法中的“CSS内部的分类及其顺序”。

注意：

在你样式中的选择器总是要以上面五类开头，然后在里面使用后代选择器。

如果这五类不能满足你的需求，你可以另外定义一个或多个大类，但必须符合单个字母+”-“为前缀的命名规则，即 .x- 的格式。

特殊：.j-将被专用于JS获取节点，请勿使用.j-定义样式。


后代选择器命名

约定不以单个字母+”-“为前缀且长度大于等于2的类选择器为后代选择器，如：.item为m-list模块里的每一个项，.text为m-list模块里的文本部分：.m-list .item{}.m-list .text{}。

一个语义化的标签也可以是后代选择器，比如：.m-list li{}。

不允许单个字母的类选择器出现，原因详见下面的“模块和元件的后代选择器的扩展类”。

通过使用后代选择器的方法，你不需要考虑他的命名是否已被使用，因为他只在当前模块或元件中生效，同样的样式名可以在不同的模块或元件中重复使用，互不干扰；在多人协作或者分模块协作的时候效果尤为明显！

后代选择器不需要完整表现结构树层级，尽量能短则短。

注意：

后代选择器不要在页面布局中使用，因为污染的可能性较大。
1
2
34
5
6
7
8

/* 这里的.itm和.cnt只在.m-list中有效 */
.m-list{ margin:0; padding:0; }
.m-list .itm{margin:1px;padding:1px}
.m-list .cnt{margin-left:100px}
/* 这里的.cnt和.num只在.m-page中有效 */
.m-page{height:20px;}
.m-page .cnt{text-algin:center;}
.m-page .num{border:1px solid #ddd}


命名应简约而不失语义

1
2
34
5
6

/* 反对：表现化的或没有语义的命名 */
.m-abc .green2{}
.m-left2{}
/* 推荐：使用有语义的简短的命名 */
.m-list .wrap2{}
.g-side2{}


相同语义的不同类命名

方法：直接加数字或字母区分即可（如：.m-lst、.m-lst2、.m-lst3等，都是列表模块，但是是完全不一样的模块）。

其他举例：.f-fw0、.f-fw1、.s-fc0、.s-fc1、.m-logo2、.m-logo3、u-btn、u-btn2等等。


模块和元件的扩展类的命名方法

当A、B、C、…它们类型相同且外形相似区别不大，那么就以它们中出现率最高的做成基类，其他做成基类的扩展。

方法：+“-”+数字或字母（如：.m-lst的扩展类为.m-lst-1、.m-lst-2等）。

补充：基类自身可以独立使用（如：class=”m-lst”即可），扩展类必须基于基类使用（如：class=”m-lst m-lst-2”）。

如果你的扩展类是表示不同状态，那么你可以这样命名：u-btn-dis，u-btn-hov，m-box-sel，m-box-hov等等，然后像这样使用：class=”u-btn u-btn-dis”。


模块和元件的后代选择器的扩展类

有时候模块内会有些类似的东西，如果你没有把它们做成元件和扩展，那么也可以使用后代选择器和扩展。

后代选择器：.m-login .btn{}。

后代选择器扩展：.m-login .btn-1{}.m-login .btn-dis{}。

注意：

此方法用于类选择器，直接使用标签做为选择器的则不需要使用此命名方法。

为防止后代选择器的扩展类和大类命名规范冲突，后代选择器不允许使用单个字母。

比如：.m-list .a{}是不允许的，因为当这个.a需要扩展的时候就会变成.a-bb，这样就和大类的命名规范冲突。


组合选择器有时可以代替扩展方法

有时候虽然两个同类型的模块很相似，但是你希望他们之间不要有依赖关系，也就是说你不希望使用扩展的方法，那么你可以通过合并选择器来设置共性的样式。

使用本方法的前提是：相同类型、功能和外观都相似，写在同一片代码区域方便维护。
1
2
34
5
6
7
8
9
10

/* 两个元件共性的样式 */
.u-tip1,.u-tip2{}
.u-tip1 .itm,.u-tip2 .itm{}
/* 在分别是两个元件各自的样式 */
/* tip1 */
.u-tip1{}
.u-tip1 .itm{}
/* tip2 */
.u-tip2{}
.u-tip2 .itm{}


防止污染和被污染

当模块或元件之间互相嵌套，且使用了相同的标签选择器或其他后代选择器，那么里面的选择器就会被外面相同的选择器所影响。

所以，如果你的模块或元件可能嵌套或被嵌套于其他模块或元件，那么要慎用标签选择器，必要时采用类选择器，并注意命名方式，可以采用.m-layer .layerxxx、.m-list2 .list2xxx的形式来降低后代选择器的污染性。


代码格式


选择器、属性和值使用小写

在xhtml标准中规定了所有标签、属性和值都小写，CSS也是如此。


单行写完一个选择器定义

便于选择器的寻找和阅读，也便于插入新选择器和编辑，便于模块等的识别。去除多余空格，使代码紧凑减少换行。

如果有嵌套定义，可以采取内部单行的形式。
1
2
34
5
6
7
8
9
10
11

/* 单行定义一个选择器 */
.m-list li,.m-list h3{ width:100px;padding:10px;border:1px solid #ddd}
/* 这是一个有嵌套定义的选择器 */
@media all and (max-width:600px){
.m-class1 .itm{height:17px;line-height:17px;font-size:12px;}
.m-class2 .itm{width:100px;overflow:hidden;}
}
@-webkit-keyframes showtime{
0%{height:0;opacity:0;}
100%{height:100px;opacity:1;}
}


最后一个值也以分号结尾

通常在大括号结束前的值可以省略分号，但是这样做会对修改、添加和维护工作带来不必要的失误和麻烦。


省略值为0时的单位

为节省不必要的字节同时也使阅读方便，我们将0px、0em、0%等值缩写为0。
1

.m-box{margin:0 10px;background-position:50% 0;}


使用单引号

省略url引用中的引号，其他需要引号的地方使用单引号。
12

.m-box{background:url(bg.png)}
.m-box:after{content:'.'}


使用16进制表示颜色值

除非你需要透明度而使用rgba，否则都使用#f0f0f0这样的表示方法，并尽量缩写。
1

.m-box{color:#f00;background:rgba(0,0,0,0.5);}


依属性的重要性按顺序书写

只遵循横向顺序即可，先显示定位布局类属性，后盒模型等自身属性，最后是文本类及修饰类属性。
显示属性自身属性文本属性和其他修饰
displaywidthfont
visibilityheighttext-algin
positionmargintext-decoration
floatpaddingvertical-algin
clearborderwhite-space
list-styleoverflowcolor
topmin-widthbackground
1

.m-box{position:relative;width:600px;margin:0 auto 10px;text-algin:center;color:#000}


私有在前，标准在后

先写带有浏览器私有标志的，后写W3C标准的。
1

.m-box{-webkit-box-shadow:0 0 0 #000;-moz-box-shadow:0 0 0 #000;box-shadow:0 0 0 #000}


注释格式：/ 注释文字 /

原则上每个系列的样式都需要有一个注释，言简意赅的表明名称、用途、注意事项等。

对选择器的注释统一写在被注释对象的上一行，对属性及值的注释写于分号后。

注释内容两端需空格，已确保即使在编码错误的情况下也可以正确解析样式。

在必要的情况下，可以使用块状注释，块状注释保持统一的缩进对齐。
1
2
34
5
6
7
8
9
10

/*
块状注释文字
块状注释文字
块状注释文字
*/
.m-lit{width:500px;}
.m-list li{height:20px;overflow:hiden;/* 这里是对overflow:hidden的一个注释 */line-height:20px;}
.m-list li a{color:#333;}
/* 单行注释文字 */
.m-list li em{color:#666}


原则上不允许使用Hack

很多不兼容问题可以通过改变方法和思路来解决，并非一定需要Hack，根据经验你完全可以绕过某些兼容问题。

一种合理的结构和合理的样式，是极少会碰到兼容问题的。

由于浏览器自身缺陷，我们无法避开的时候，可以允许使用适当的Hack。


统一Hack方法

统一使用“*”和“_”分别对IE7和6进行Hack。如下代码所示：
12

/* IE7会显示灰色#888，IE6会显示白色#fff，其他浏览器会显示黑色#000 */
.m-list{color:#000;*color:#888;_color:#fff;}


建议并适当缩写值

“建议并适当”是因为缩写总是会包含一系列的值，而有时候我们并不希望设置某一值，反而造成了麻烦，那么这时候你可以不缩写，而是分开写。

当然，在一切可以缩写的情况下，请务必缩写，它最大的好处就是节省了字节，便于维护，并使阅读更加一目了然。

缩写方法请查阅css手册。


选择器顺序

请综合考虑以下顺序依据：

从大到小（以选择器的范围为准）

从低到高（以等级上的高低为准）

从先到后（以结构上的先后为准）

从父到子（以结构上的嵌套为准）

以下仅为简单示范：
1
2
34
5
6
7
8
9
10
1112
13

/* 从大到小 */
.m-list p{margin:0;padding:0;}
.m-list p.part{margin:1px;padding:1px;}
/* 从低到高 */
.m-logo a{color:#f00;}
.m-logo a:hover{color:#fff}
/* 从先到后 */
.g-hd{height:60px;}
.g-bd{height:60px;}
.g-ft{height:60px;}
/* 从父到子 */
.m-list{width:300px;}
.m-list .itm{float:left;}


选择器等级

a = 行内样式style。

b = ID选择器的数量。

c = 类、伪类和属性选择器的数量。

d = 类型选择器和伪元素选择器的数量。
选择器等级（A,B,C,D）
style=””1,0,0,0
#wrapper #content{}0,2,0,0
#content .dateposted{}0,1,1,0
div#content{}0,1,0,1
#content p{}0,1,0,1
#content{}0,1,0,0
p.comment .dateposted{}0,0,2,1
div.comment p{}0,0,1,2
.comment p{}0,0,1,1
p.commnet{}0,0,1,1
.commnet{}0,0,1,0
div p{}0,0,0,2
p{}0,0,0,1


优化方案


值缩写

缩写值可以减少CSS文件大小，并增加可读性和可维护性。

但并非所有的值都必须缩写，因为当一个属性的值缩写时，总是会将所有项都设置一遍，而有时候我们不希望设置值里的某些项。
1
2
34
5
6
7
8

/*
比如我们用下面这个样式让某个定宽的容器水平居中，我们要的只是left和right，
而top和buttom不是这个样式要关心的（如果设置了反倒会影响其他样式在这个容器上的使用），
所以这时我们就不需要编写
*/
.f-mgha{margin-left:auto;margin-right:auto;}
/* 比如下面这个模块的样式设置，我们确实需要设置padding的所有项，于是我们就可以采用缩写 */
.m-link{padding:6px 12px;}

常用的缩写方法请参见代码格式。


避免耗性能的属性

以下所举列的属性可能造成渲染性能问题。不过有时候需求大于一切……
1
2
34

/* expression */
.class{width:expression(this.width>100?'100px':'auto')}
/* filter */
.class{filter:alpha(opacity=50)}


选择器合并

即CSS选择器组合，可以一次定义多个选择器，为你节省很多字节和宝贵时间。

通常我们会将定义相同的或者有大部分属性值相同（确实是因为相关而相同）的一系列选择器组合到一起（采用逗号的方法）来统一定义。
1
2
34
5
6
7
8
9
10

/* 以下对布局类选择器统一做了清楚浮动的操作 */
.g-hd:after,.g-bd:after,.g-ft:after{diaplay:block;visibility:hidden;clear:both;height:0;centent:".";}
.g-hd,.g-bd,.g-ft{zoom:1;}
/* 通常background总是会占用很多字节，所以一般情况下，我们都会这样统一调用 */
.m-logo,.m-help,.m-list li,u-tab li a{background:url(../images/sprite.png) no-repeat 9999px 9999px}
.m-logo{background-position:0 0;}
/* 以下是某个元件的写法，因为确实很多元素是联动的或相关的，所以采用了组合写法，可以方便理解和修改 */
.u-tab li,.u-tab li a{display:inline;float:left;height:30px;line-height:30px;}
.u-tab li{margin:0 30px;}
.u-tab li a{padding:0 6px;}


背景图优化合并

图片本身的优化：

图像质量要求和图像文件大小决定你用什么格式的图片，用较小的图片文件呈现较好的图像质量。

当图片色彩过于丰富且无透明要求时，建议采用jpg格式并保存为较高质量。

当图片色彩过于丰富又有透明或半透明要求或阴影效果时，建议采用png24格式，并对IE6进行png8退化（或在不得已情况下使用滤镜）。

当图片色彩不太丰富时无论有无透明要求，请采用png8格式，大多数情况下建议采用这种格式。

当图片有动画时，只能使用gif格式。

你可以使用工具对图片进行再次压缩，但前提是不会影响色彩和透明。

多张图片的合并：

单个图标之间必须保留空隙，空隙大小由容器大小及显示方式决定。这样做的好处是既考虑了“容错性”又提高了图片的可维护性。

图标的排列方式，也由容器大小及显示方式决定。排列方式分为以下几种：横向排列（容器宽度有限）、纵向排列（容器高度有限）、斜线排列（容器宽高

不限），靠左排列（容器背景居左）、靠右排列（容器背景居右）、水平居中排列（容器背景水平居中）、垂直居中排列（容器背景垂直居中）。

合并后图片大小不宜超过50K，建议大小在20K-50K之间。

为保证多次修改后的图片质量，请保留一份PSD原始图，修改和添加都在PSD中进行，最后导出png。

分类合并：

并不是把所有的图标都合并在一张图片里就是最好的，除了要控制图片大小之外还要注意以下方法。

按照图片排列方式，把排列方式一样的图片进行合并，便于样式控制。

按照模块或元件，把同属于一个模块或元件的图片进行合并，方便模块或元件的维护。

按照图片大小，把大小一致或差不多的图片进行合并，可充分利用图片空间。

按照图片色彩，把色彩一致或差不多的图片进行合并，保证合并后图片的色彩不过于丰富，可防止色彩失真。

综合以上方法进行合并。


Hack的避免

当避免的代价较大时，可以使用Hack而不避免，比如你需要增加很多HTML或多写很多CSS时会得不偿失。

丰富的实战经验可以帮助你了解那些常见问题并用多种不同的思路来避免它，所以经验和思维方法在这里显得很重要。

根据你自己的能力来解决Hack的问题，我们不建议你用一个自己都没有把握的方法来避免Hack，因为也许你这个方法本身存在你没有发现的问题。


便于阅读修改

如果你做到了“CSS规范”的所有要求，自然你也就写出了一个便于阅读和修改的漂亮的CSS。

当然，代码格式和命名规则是相对重要一些的。


清晰的CSS模块

如果你做到了命名规则的要求，你的CSS模块也就清晰可见了。

用“注释”来说明每一个模块对于较大的CSS文件来说显得尤为重要。


文件压缩

合理的书写CSS能很大程度上减少文件大小，完成后，在不损坏文件内容的情况下，想尽一切办法压缩你的CSS，你可以借助压缩工具把注释和多余的空格、换

行去掉。

压缩工具详见：“HTML/CSS工具”部分。


其他格式优化

优化方法请参见代码格式。


最佳实践


最佳选择器写法（模块）

1
2
34
5
6
7
8
9
10
1112
13
14
15
16
17
18

/* 这是某个模块 */
.m-nav{} /* 模块容器 */
.m-nav li,.m-nav a{} /*先共性 优化组合*/
.m-nav li{}/* 后个性 语义化标签选择器 */
.m-nav a{}/* 后个性中的共性 按结构顺序 */
.m-nav a.a1{}/* 后个性中的个性 */
.m-nav a.a2{}/* 后个性中的个性 */
.m-nav .crt a{}/* 交互状态变化 */
.m-nav .crt a.a1{}
.m-nav .crt a.a2{}
.m-nav .btn{}/* 典型后代选择器 */
.m-nav .btn-1{}/* 典型后代选择器扩展 */
.m-nav .btn-dis{}/* 典型后代选择器扩展 */
.m-nav .m-sch{}/*控制内部其他模块位置*/
.m-nav .u-sel{}/* 控制内部其他元件位置 */
.m-nav-1{}/* 模块扩展 */
.m-nav-1 li{}
.m-nav-big{}/* 模块扩展 */


统一语义理解和命名





典型错误


不符合NEC规范的选择器用法

.class{}

不要以一个没有类别的样式作为主选择器，这样的选择器只能作为后代选择器使用，比如.m-xxx .class{}。

.m-xxx div{}

不要以没有语义的标签作为选择器，这会造成大面积污染，除非你可以断定现在或将来你的这个选择器不会污染其他同类。

.g-xxx .class{}

不要在页面布局中使用后代选择器，因为这个后代选择器可能会污染里面的元素。

.g-xxx .m-yyy{}.g-xxx .u-yyy{}

不要用布局去控制模块或元件，模块和元件应与布局分离独立。

.m-xxx .f-xxx{}.m-xxx .s-xxx{}

不要通过模块或其他类来重定义或修改或添加已经定义好的功能类选择器和皮肤类选择器。

.m-xxx .class .class .class .class{}

不要将选择器写的过于冗长，这会额外增加文件大小并且限制了太小范围的选择器，使树形结构过于严格应用范围过于局限，建议3-4个长度之内写完。

选择器并不需要完整反映结构嵌套顺序，相反，能简则简。

.m-xxx .m-yyy .zzz{}

不要越级控制，如果.zzz是.m-yyy的后代选择器，那么不允许.m-yyy之外的选择器控制或修改.zzz。

此时可以使用.m-yyy的扩展来修改.zzz，比如.m-yyy-1 .zzz{}。


扩展类使用错误

扩展类必须和其基类同时使用于同一个节点。

错误：class=”g-xxx g-yyy-1” class=”m-xxx-1” class=”u-xxx u-yyy-1” class=”xxx-yyy”。

正确：class=”g-xxx g-xxx-1” class=”m-xxx m-xxx-1” class=”u-yyy u-yyy-1” class=”xxx xxx-yyy”。

本文由吾老师“龙哥有话说”原创，如有转载，必须声明！

本文标题:网易前端CSS编码规范

文章作者:龙哥有话说

发布时间:2015年11月27日 - 22时18分

最后更新:2015年11月28日 - 00时45分

原始链接:http://www.longestory.com/css/css-coding-standards.html

许可协议: "署名-非商用-相同方式共享
3.0" 转载请保留原文链接及作者
内容来自用户分享和网络整理，不保证内容的准确性，如有侵权内容，可联系管理员处理 点击这里给我发消息
标签： 
相关文章推荐
新的分享
章节导航