[编码规范][css][总汇] - 前端css编写规范

前言

为什么要写编码规范呢?我希望在一个团队里面能形成一种规范,小到程序编码格式(如是否驼峰还是横 杆,css属性书写时候的顺序),大到一个团队里面协调配合进行组件开发(如模块化、组件化编程、方便团队合作和修改代码)。每个团队都应该具备有这么一套规范,我通俗称他为团队默契。当你掌握了一套编码规范,并以之为习惯,我相信这不仅是对你编码生涯的一个产生较大的影响,而且还有对你的职业生涯有个美好的开端。

简要

总体分为:css篇、js篇、编码篇。
同时提一下:遇到不懂或没有见过的技术,请查阅文档,请查阅文档,请查阅文档,重要的事情说三次。

前方高能〇

css篇:
css编码设置

在编写css的头部添加UTF-8编码
@charset "utf-8";

类名命名空间规范

布局:以g为命名空间,如:g-wrap,g-header,g-content
工具:以u为命名空间,表示不耦合、可复用的辅助工具,如:u-clearfix,u-ellipsis,u-text-right
组件:以m为命名空间,表示可复用、移植的组件模块,如:m-header、m-slide、m-aside-post
状态:以s为命名空间,表示动态的、具有交互实质的状态(简单理解即:动态取值),如:s-current、s-selected,s-option,
钩子:以h为命名空间,表示特定给JavaScript调用的类名,只作为钩子调用,如:h-request,h-open,h-slide

类名组合方式

统一小写字母,并以横杆(-)来链接,如:g-header,g-topbar

选择器
当一个规则包含多个选择器时,每个选择器独占一行。
、+、~、> 选择器的两边各保留一个空格。
如:
.g-header > .g-header-des,
.g-content ~ .g-footer {}

规则声明块

当规则声明块中有多个样式声明时,每条样式独占一行。
在规则声明块的左大括号 { 前加一个空格。
在样式属性的冒号 : 后面加上一个空格,前面不加空格。
在每条样式后面都以分号 ; 结尾。
规则声明块的右大括号 } 独占一行。
每个规则声明间用空行分隔。
所有最外层引号使用单引号 ' 。
当一个属性有多个属性值时,以逗号 , 分隔属性值,每个逗号后添加一个空格,当单个属性值过长时,每个属性值独占一行。
如:
.g-footer,
.g-header {
position: relative;
}

.g-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%);
  }
 
.g-content::before {
  content: '';
}

数值与单位

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

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

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

    margin: 0px auto
    
    margin: 0 auto

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

    color: #ffcc00
    
    color: #fc0

样式属性顺序
单个样式规则下的属性在书写时,应按功能进行分组,

并以 Positioning Model > Box Model > Typographic > Visual 的顺序书写,

提高代码的可读性。如果包含 content 属性,应放在最前面。
因为从排序从开头到结尾,能影响不仅的就是model,其次是内容排版,最好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 / ...

排列结构如:
Positioning Model
|
Box Model
|
Typographic
|
Visual

代码案例如:
g-header {
position : relative ;
display:flex;
left: 100px;
margin : 0;
border : 1px solid #f0f0f0;
z-index : 100;
height :36px;
line-height : 36px;
font-size : 14px;
color : #fff;
animation : .5s ease all;
}

合理使用使用引号

在某些样式中,会出现一些含有空格的关键字或者中文关键字。

font-family 内使用引号
当字体名字中间有空格,中文名字体及 Unicode 字符编码表示的中文字体,为了保证兼容性,都建议在字体两端添加单引号或者双引号:
如果路径里面有空格,旧版 IE 是无法识别的,会导致路径失效,建议不管是否存在空格,都添加上单引号或者双引号:
body {
font-family: 'Microsoft YaHei', '黑体-简', '\5b8b\4f53';
}

background-image 的 url 内使用引号
div {
  background-image: url('...');
}

避免使用 !important
除去某些极特殊的情况,尽量不要不要使用 !important。

代码注释
单行注释
星号与内容之间必须保留一个空格。
如:
/* 表格隔行变色 */

多行注释
星号要一列对齐,星号与内容之间必须保留一个空格。
如:
/**
* Sometimes you need to include optional context for the entire component. Do that up here if it's important enough.
*/

规则声明块内注释
使用 // 注释,// 后面加上一个空格,注释独立一行。
如:
.g-footer {
border: 0;
// ....
}

文件注释
文件顶部必须包含文件注释,用 @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标识,一方面是尊重劳动成果,另一方面方便在需要时快速定位责任人。

css框架

建议使用sass或stylus框架

使用 SASS ,经常会预先定义好一些常用公用组件类,譬如清除浮动,水平垂直居中,文字 ellipsis。又或者多个元素具有同样的样式,我们希望能够少写这部分代码,公共部分抽离出来只写一次,达到复用。
但是复用的方式在 SASS 中有多种,那么是使用单独使用一个类定义,给需要的标签添加,还是使用 @include 或者 @extend在定义的类中引入一个 @mixin,或者一个 @function 呢?
基于让 CSS 更简洁以及代码的复用考虑,采用上面的使用 %placeholders 定义,使用 @extend 引用的方案。

  1. %placeholders,只是一个占位符,只要不通过 @extend 调用,编译后不会产生任何代码量
  2. 使用 @extend 引用,则是因为每次调用相同的 %placeholders 时,编译出来相同的 CSS 样式会进行合并(反之,如果使用 @include 调用定义好的 @mixin,编译出来相同的 CSS 样式不会进行合并)
  3. 这里的组件类特指那些不会动态改变的 CSS 样式,注意与那些可以通过传参生成不同数值样式的 @mixin 方法进行区分

元素嵌套格式
尽量避免使用标签名
如:
HTML:
<div class="g-content">
<ul class="g-content-list">
<li class="item"></li>
<li class="item"></li>
<li class="item"></li>
<li class="item"></li>
</ul>
</div>
在给最里层的标签命名书写样式的时候,我们有两种选择:
.g-content {
.g-content-list {
li {
...
}
}
}
或者是
.g-content {
.g-content-list {
.item {
...
}
}
}
也就是,编译之后生成了下面这两个,到底使用哪个好呢?

.g-content .g-content-list li { }
.g-content .g-content-list .item { }

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

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

我觉得不同的规范都有各自的长处与缺陷,对待所谓的规范最好的方式不是人云亦云,拿来就用,而是应该结合实际情况及需求,取长补短,取其精华去其糟粕。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 157,538评论 4 361
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,800评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,329评论 0 238
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,725评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,089评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,449评论 1 212
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,758评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,448评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,152评论 1 239
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,432评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,933评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,289评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,921评论 3 234
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,023评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,781评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,477评论 2 270
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,381评论 2 263

推荐阅读更多精彩内容

  • 概要 64学时 3.5学分 章节安排 电子商务网站概况 HTML5+CSS3 JavaScript Node 电子...
    阿啊阿吖丁阅读 8,616评论 0 3
  • 作者:伯乐在线/chokcocohttp://web.jobbole.com/91792/ 可能不同团队都有各自的...
    grain先森阅读 940评论 0 23
  • 本文的所列是实践当中得出的一套比较不错的 CSS 书写规范,并不希望大家完全采用,而是希望可以结合自己的团队需要,...
    青衣诶_阅读 288评论 0 0
  • Ba la la la ~ 读者朋友们,你们好啊,又到了冷锋时间,话不多说,发车! 编码设置 采用 UT...
    王饱饱阅读 263评论 0 1
  • 作为前端的设计人员,对于CSS的接触,就像吃饭一样。所以CSS命名规范命名是前端人员必看的。文章整理了Web前端开...
    君惜丶阅读 1,909评论 0 8