CSS:编码规范

摘要：空格强制选择器与之间必须包含空格。示例长度强制长度为时须省略单位。示例建议颜色值中的英文字符采用小写。示例注释普通注释普通注释区块注释模块命名规范命名组成命名必须由单词，中划线组成。设置文件编码为。

</>复制代码 
.selector {
    margin: 0;
    padding: 0;
}

</>复制代码 
.selector {
}

margin: 0;

font-family: Aria, sans-serif;

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

</>复制代码 
/* 不同属性值按逻辑分组 */
background:
    transparent url(aVeryVeryVeryLongUrlIsPlacedHere)
    no-repeat 0 0;
/* 可重复多次的属性，每次重复一行 */
background-image:
    url(aVeryVeryVeryLongUrlIsPlacedHere)
    url(anotherVeryVeryVeryLongUrlIsPlacedHere);
/* 类似函数的属性值可以根据函数调用的缩进进行 */
background-image: -webkit-gradient(
    linear,
    left bottom,
    left top,
    color-stop(0.04, rgb(88,94,124)),
    color-stop(0.52, rgb(115,123,162))
);

</>复制代码 
/* good */
.post,
.page,
.comment {
    line-height: 1.5;
}
/* bad */
.post, .page, .comment {
    line-height: 1.5;
}

示例：

</>复制代码 
/* good */
main > nav {
    padding: 10px;
}
label + input {
    margin-left: 5px;
}
input:checked ~ button {
    background-color: #69C;
}
/* bad */
main>nav {
    padding: 10px;
}
label+input {
    margin-left: 5px;
}
input:checked~button {
    background-color: #69C;
}

</>复制代码 
css
/* good */
article[character="juliet"] {
    voice-family: "Vivien Leigh", victoria, female
}
/* bad */
article[character="juliet"] {
    voice-family: "Vivien Leigh", victoria, female
}

解释：在性能和维护性上，都有一定的影响。

示例：

</>复制代码 
css
/* good */
#error,
.danger-message {
    font-color: #c00;
}
/* bad */
dialog#error,
p.danger-message {
    font-color: #c00;
}

示例：

</>复制代码 
/* good */
#username input {}
.comment .avatar {}
/* bad */
.page .header .login #username input {}
.comment div * {}

示例：

</>复制代码 
/* good */
.post {
    font: 12px/1.5 arial, sans-serif;
}
/* bad */
.post {
    font-family: arial, sans-serif;
    font-size: 12px;
    line-height: 1.5;
}

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

示例：

</>复制代码 
/* centering 
 horizontally and highlight featured ones */
article {
    margin: 5px;
    border: 1px solid #999;
}
/* good */
.page {
    margin-right: auto;
    margin-left: auto;
}
.featured {
    border-color: #69c;
}
/* bad */
.page {
    margin: 5px auto; /* introducing redundancy */
}
.featured {
    border: 1px solid #69c; /* introducing redundancy */
}

</>复制代码 
/* good */
.selector1 {
  display: block;
  width: 100px;
}
.selector2 {
  padding: 10px;
  margin: 10px auto;
}
/* bad */
.selector1 {
  display: block;
  width: 100px;
}
.selector2 {
  padding: 10px;
  margin: 10px auto;
}

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

</>复制代码 
/* good */
html[lang|="zh"] q:before {
    font-family: "Microsoft YaHei", sans-serif;
    content: "“";
}
html[lang|="zh"] q:after {
    font-family: "Microsoft YaHei", sans-serif;
    content: "”";
}
/* bad */
html[lang|=zh] q:before {
    font-family: "Microsoft YaHei", sans-serif;
    content: "“";
}
html[lang|=zh] q:after {
    font-family: "Microsoft YaHei", sans-serif;
    content: "”";
}

示例：

</>复制代码 
/* good */
panel {
    opacity: .8
}
/* bad */
panel {
    opacity: 0.8
}

示例：

</>复制代码 
body {
    background: url(bg.png);
}

示例：

</>复制代码 
/* good */
body {
    padding: 0 5px;
}
/* bad */
body {
    padding: 0px 5px;
}

</>复制代码 
/* good */
.success {
    box-shadow: 0 0 2px rgba(0, 128, 0, .3);
    border-color: #008000;
}
/* bad */
.success {
    box-shadow: 0 0 2px rgba(0,128,0,.3);
    border-color: rgb(0, 128, 0);
}

示例：

</>复制代码 
/* good */
.success {
    background-color: #aca;
}
/* bad */
.success {
    background-color: #aaccaa;
}

示例：

</>复制代码 
/* good */
.success {
    color: #90ee90;
}
/* bad */
.success {
    color: lightgreen;
}

示例：

</>复制代码 
/* good */
.success {
    background-color: #aca;
    color: #90ee90;
}
/* good */
.success {
    background-color: #ACA;
    color: #90EE90;
}
/* bad */
.success {
    background-color: #ACA;
    color: #90ee90;
}

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

示例：

</>复制代码 
/* good */
body {
    background-position: center top; /* 50% 0% */
}
/* bad */
body {
    background-position: top; /* 50% 0% */
}

解释：
所谓英文 Family Name，为字体文件的一个元数据，常见名称如下：

示例：

</>复制代码 
h1 {
    font-family: "Microsoft YaHei";
}

解释：
更详细说明可参考本文。

示例：

</>复制代码 
/* Display according to platform */
.article {
    font-family: Arial, sans-serif;
}
/* Specific for most platforms */
h1 {
    font-family: "Helvetica Neue", Arial, "Hiragino Sans GB", "WenQuanYi Micro Hei", "Microsoft YaHei", sans-serif;
}

示例：

</>复制代码 
/* good */
body {
    font-family: Arial, sans-serif;
}
h1 {
    font-family: Arial, "Microsoft YaHei", sans-serif;
}
/* bad */
body {
    font-family: arial, sans-serif;
}
h1 {
    font-family: Arial, "Microsoft YaHei", sans-serif;
}

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

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

示例：

</>复制代码 
/* good */
.box {
    transition: color 1s, border-color 1s;
}
/* bad */
.box {
    transition: all 1s;
}

解释：
见本文，在可能的情况下应选择这样四种变换：

transform: translate(npx, npx);

transform: scale(n);

transform: rotate(ndeg);

opacity: 0..1;

典型的，可以使用 translate 来代替 left 作为动画属性。
示例：

</>复制代码 
/* good */
.box {
    transition: transform 1s;
}
.box:hover {
    transform: translate(20px); /* move right for 20px */
}
/* bad */
.box {
    left: 0;
    transition: left 1s;
}
.box:hover {
    left: 20px; /* move right for 20px */
}

示例：

</>复制代码 
@media
(-webkit-min-device-pixel-ratio: 2), /* Webkit-based browsers */
(min--moz-device-pixel-ratio: 2),    /* Older Firefox browsers (prior to Firefox 16) */
(min-resolution: 2dppx),             /* The standard way */
(min-resolution: 192dpi) {           /* dppx fallback */
    /* Retina-specific stuff here */
}

/* 普通注释 */

</>复制代码 
/**
 * 模块：m-detail
 * author: xxx
 * edit:   2016.5.02
 */

命名必须由单词，中划线组成。例如:.info,.news-list

不推荐使用拼音来作为样式名，尤其是缩写的拼音、拼音与英文的混合

所有命名都使用小写,使用中划线 “-” 作为连接字符，而不是下划线 “_“

不允许出现以类似：.info, .current, .news 开头的选择器，比如：

.info{sRules;}
因为这样将给我们带来不可预知的管理麻烦以及沉重的历史包袱。你永远也不会知道哪些样式名已经被用掉了，如果你是一个新人，你可能会遭遇，你每定义个样式名，都有同名的样式已存在，然后你只能是换样式名或者覆盖规则。所以我们推荐这样写：

.m-xxx .info{sRules;}
所有的选择器必须是以 g-, m-, ui- 等有前缀的选择符开头的，意思就是说所有的规则都必须在某个相对的作用域下才生效，尽可能减少全局污染。 J- 这种级别的className完全交由JSer自定义，但是命名的规则也可以保持跟重构一致，比如说不能使用拼音之类的

不以表现来命名，而是根据内容来命名。比如：left, right, center, red, black这种以表现来定命名，不允许出现；

推荐使用功能和内容相关词汇的命名，如:

</>复制代码 
套系:package
相册:photo-album
作品:works
攻略:raiders
普通用户:normal-user 
达人:talent-user
摄影师:photographer
用户昵称:user-alias
头像:head
地区:area
关注数:follow
粉丝数:followers
互相注意:attention
标签:label
发表时间:publish-date,publish-time
标题:title
信息:info
内容:content
关于我:about
简介内容:intro-content
评论:review 
服务:service
封面:cover
流行:popular
收藏:collect
查看:view
预约:reservation
促销:sale-promotion

(待补充)

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

使用4个空格缩进

使用Unix风格换行符(LF)

保存文件时，删除尾部的空白符。

设置文件编码为 UTF-8。

在文件结尾添加一个空白行。

参照文档并将这些配置信息添加到项目的 .editorconfig文件中。

</>复制代码 
// 示例
# css-creating coding style
root = true
# 为所有文件设置风格
[*]
charset = utf-8
indent_style = space
indent_size = 4
end_of_line = lf
trim_trailing_whitespace = true
insert_final_newline = true
# 为 Markdown 文件保留行尾空格
[*.md]
trim_trailing_whitespace = false