CSS編碼規(guī)范

CSS 作為網(wǎng)頁(yè)樣式的描述語(yǔ)言，在百度一直有著廣泛的應(yīng)用。本文檔的目標(biāo)是使 CSS 代碼風(fēng)格保持一致，容易被理解和被維護(hù)。

雖然本文檔是針對(duì) CSS 設(shè)計(jì)的，但是在使用各種 CSS 的預(yù)編譯器(如 less、sass、stylus 等)時(shí)，適用的部分也應(yīng)盡量遵循本文檔的約定。

• 原文來(lái)源：Github

1 前言

2 代碼風(fēng)格

　　2.1 文件

　　2.2 縮進(jìn)

　　2.3 空格

　　2.4 行長(zhǎng)度

　　2.5 選擇器

　　2.6 屬性

3 通用

　　3.1 選擇器

　　3.2 屬性縮寫(xiě)

　　3.3 屬性書(shū)寫(xiě)順序

　　3.4 清除浮動(dòng)

　　3.5 !important

　　3.6 z-index

4 值與單位

　　4.1 文本

　　4.2 數(shù)值

　　4.3 url()

　　4.4 長(zhǎng)度

　　4.5 顏色

　　4.6 2D 位置

5 文本編排

　　5.1 字體族

　　5.2 字號(hào)

　　5.3 字體風(fēng)格

　　5.4 字重

　　5.5 行高

6 變換與動(dòng)畫(huà)

7 響應(yīng)式

8 兼容性

　　8.1 屬性前綴

　　8.2 Hack

　　8.3 Expression

1 前言

CSS 作為網(wǎng)頁(yè)樣式的描述語(yǔ)言，在百度一直有著廣泛的應(yīng)用。本文檔的目標(biāo)是使 CSS 代碼風(fēng)格保持一致，容易被理解和被維護(hù)。

雖然本文檔是針對(duì) CSS 設(shè)計(jì)的，但是在使用各種 CSS 的預(yù)編譯器(如 less、sass、stylus 等)時(shí)，適用的部分也應(yīng)盡量遵循本文檔的約定。

2 代碼風(fēng)格

2.1 文件

[建議]?CSS?文件使用無(wú)?BOM?的?UTF-8?編碼。

解釋?zhuān)?/p>

UTF-8 編碼具有更廣泛的適應(yīng)性。BOM 在使用程序或工具處理文件時(shí)可能造成不必要的干擾。

2.2 縮進(jìn)

[強(qiáng)制] 使用?4?個(gè)空格做為一個(gè)縮進(jìn)層級(jí)，不允許使用?2?個(gè)空格 或?tab?字符。

示例：

.selector {
    margin: 0;
    padding: 0;
}

2.3 空格

[強(qiáng)制]?選擇器?與?{?之間必須包含空格。

示例：

.selector {
}

[強(qiáng)制]?屬性名?與之后的?:?之間不允許包含空格，?:?與?屬性值?之間必須包含空格。

示例：

margin: 0;

[強(qiáng)制]?列表型屬性值?書(shū)寫(xiě)在單行時(shí)，,?后必須跟一個(gè)空格。

示例：

font-family: Arial, sans-serif;

2.4 行長(zhǎng)度

[強(qiáng)制] 每行不得超過(guò)?120?個(gè)字符，除非單行不可分割。

解釋?zhuān)?/p>

常見(jiàn)不可分割的場(chǎng)景為URL超長(zhǎng)。

[建議] 對(duì)于超長(zhǎng)的樣式，在樣式值的?空格?處或?,?后換行，建議按邏輯分組。

示例：

/* 不同屬性值按邏輯分組 */
background:
    transparent url(aVeryVeryVeryLongUrlIsPlacedHere)
    no-repeat 0 0;

/* 可重復(fù)多次的屬性，每次重復(fù)一行 */
background-image:
    url(aVeryVeryVeryLongUrlIsPlacedHere)
    url(anotherVeryVeryVeryLongUrlIsPlacedHere);

/* 類(lèi)似函數(shù)的屬性值可以根據(jù)函數(shù)調(diào)用的縮進(jìn)進(jìn)行 */
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))
);

2.5 選擇器

[強(qiáng)制] 當(dāng)一個(gè) rule 包含多個(gè) selector 時(shí)，每個(gè)選擇器聲明必須獨(dú)占一行。

示例：

/* good */
.post,
.page,
.comment {
    line-height: 1.5;
}

/* bad */
.post, .page, .comment {
    line-height: 1.5;
}

[強(qiáng)制]?>、+、~?選擇器的兩邊各保留一個(gè)空格。

示例：

/* 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;
}

[強(qiáng)制] 屬性選擇器中的值必須用雙引號(hào)包圍。

解釋?zhuān)?/p>

不允許使用單引號(hào)，不允許不使用引號(hào)。

示例：

/* good */
article[character="juliet"] {
    voice-family: "Vivien Leigh", victoria, female;
}

/* bad */
article[character='juliet'] {
    voice-family: "Vivien Leigh", victoria, female;
}

2.6 屬性

[強(qiáng)制] 屬性定義必須另起一行。

示例：

/* good */
.selector {
    margin: 0;
    padding: 0;
}

/* bad */
.selector { margin: 0; padding: 0; }

[強(qiáng)制] 屬性定義后必須以分號(hào)結(jié)尾。

示例：

/* good */
.selector {
    margin: 0;
}

/* bad */
.selector {
    margin: 0
}

3 通用

3.1 選擇器

[強(qiáng)制] 如無(wú)必要，不得為?id、class?選擇器添加類(lèi)型選擇器進(jìn)行限定。

解釋?zhuān)?/p>

在性能和維護(hù)性上，都有一定的影響。

示例：

/* good */
#error,
.danger-message {
    font-color: #c00;
}

/* bad */
dialog#error,
p.danger-message {
    font-color: #c00;
}

[建議] 選擇器的嵌套層級(jí)應(yīng)不大于?3?級(jí)，位置靠后的限定條件應(yīng)盡可能精確。

示例：

/* good */
#username input {}
.comment .avatar {}

/* bad */
.page .header .login #username input {}
.comment div * {}

3.2 屬性縮寫(xiě)

[建議] 在可以使用縮寫(xiě)的情況下，盡量使用屬性縮寫(xiě)。

示例：

/* 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?等縮寫(xiě)時(shí)，應(yīng)注意隱含值對(duì)實(shí)際數(shù)值的影響，確實(shí)需要設(shè)置多個(gè)方向的值時(shí)才使用縮寫(xiě)。

解釋?zhuān)?/p>

border?/?margin?/?padding?等縮寫(xiě)會(huì)同時(shí)設(shè)置多個(gè)屬性的值，容易覆蓋不需要覆蓋的設(shè)定。如某些方向需要繼承其他聲明的值，則應(yīng)該分開(kāi)設(shè)置。

示例：

/* centering <article class="page"> 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 */
}

3.3 屬性書(shū)寫(xiě)順序

[建議] 同一 rule set 下的屬性在書(shū)寫(xiě)時(shí)，應(yīng)按功能進(jìn)行分組，并以?Formatting Model（布局方式、位置） > Box Model（尺寸） > Typographic（文本相關(guān)） > Visual（視覺(jué)效果）?的順序書(shū)寫(xiě)，以提高代碼的可讀性。

解釋?zhuān)?/p>

• Formatting Model 相關(guān)屬性包括：position?/?top?/?right?/?bottom?/?left?/?float?/?display?/?overflow?等
• Box Model 相關(guān)屬性包括：border?/?margin?/?padding?/?width?/?height?等
• Typographic 相關(guān)屬性包括：font?/?line-height?/?text-align?/?word-wrap?等
• Visual 相關(guān)屬性包括：background?/?color?/?transition?/?list-style?等

另外，如果包含?content?屬性，應(yīng)放在最前面。

示例：

.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;
}

3.4 清除浮動(dòng)

[建議] 當(dāng)元素需要撐起高度以包含內(nèi)部的浮動(dòng)元素時(shí)，通過(guò)對(duì)偽類(lèi)設(shè)置?clear?或觸發(fā)?BFC?的方式進(jìn)行?clearfix。盡量不使用增加空標(biāo)簽的方式。

解釋?zhuān)?/p>

觸發(fā) BFC 的方式很多，常見(jiàn)的有：

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

如希望使用更小副作用的清除浮動(dòng)方法，參見(jiàn)?A new micro clearfix hack?一文。

另需注意，對(duì)已經(jīng)觸發(fā) BFC 的元素不需要再進(jìn)行 clearfix。

3.5 !important

[建議] 盡量不使用?!important?聲明。

[建議] 當(dāng)需要強(qiáng)制指定樣式且不允許任何場(chǎng)景覆蓋時(shí)，通過(guò)標(biāo)簽內(nèi)聯(lián)和?!important?定義樣式。

解釋?zhuān)?/p>

必須注意的是，僅在設(shè)計(jì)上?確實(shí)不允許任何其它場(chǎng)景覆蓋樣式?時(shí)，才使用內(nèi)聯(lián)的?!important?樣式。通常在第三方環(huán)境的應(yīng)用中使用這種方案。下面的?z-index?章節(jié)是其中一個(gè)特殊場(chǎng)景的典型樣例。

3.6 z-index

[建議] 將?z-index?進(jìn)行分層，對(duì)文檔流外絕對(duì)定位元素的視覺(jué)層級(jí)關(guān)系進(jìn)行管理。

解釋?zhuān)?/p>

同層的多個(gè)元素，如多個(gè)由用戶(hù)輸入觸發(fā)的 Dialog，在該層級(jí)內(nèi)使用相同的?z-index?或遞增?z-index。

建議每層包含100個(gè)?z-index?來(lái)容納足夠的元素，如果每層元素較多，可以調(diào)整這個(gè)數(shù)值。

[建議] 在可控環(huán)境下，期望顯示在最上層的元素，z-index?指定為?999999。

解釋?zhuān)?/p>

可控環(huán)境分成兩種，一種是自身產(chǎn)品線環(huán)境；還有一種是可能會(huì)被其他產(chǎn)品線引用，但是不會(huì)被外部第三方的產(chǎn)品引用。

不建議取值為?2147483647。以便于自身產(chǎn)品線被其他產(chǎn)品線引用時(shí)，當(dāng)遇到層級(jí)覆蓋沖突的情況，留出向上調(diào)整的空間。

[建議] 在第三方環(huán)境下，期望顯示在最上層的元素，通過(guò)標(biāo)簽內(nèi)聯(lián)和?!important，將?z-index?指定為?2147483647。

解釋?zhuān)?/p>

第三方環(huán)境對(duì)于開(kāi)發(fā)者來(lái)說(shuō)完全不可控。在第三方環(huán)境下的元素，為了保證元素不被其頁(yè)面其他樣式定義覆蓋，需要采用此做法。

4 值與單位

4.1 文本

[強(qiáng)制] 文本內(nèi)容必須用雙引號(hào)包圍。

解釋?zhuān)?/p>

文本類(lèi)型的內(nèi)容可能在選擇器、屬性值等內(nèi)容中。

示例：

/* 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: "”";
}

4.2 數(shù)值

[強(qiáng)制] 當(dāng)數(shù)值為 0 – 1 之間的小數(shù)時(shí)，省略整數(shù)部分的?0。

示例：

/* good */
panel {
    opacity: .8;
}

/* bad */
panel {
    opacity: 0.8;
}

4.3 url()

[強(qiáng)制]?url()?函數(shù)中的路徑不加引號(hào)。

示例：

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

[建議]?url()?函數(shù)中的絕對(duì)路徑可省去協(xié)議名。

示例：

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

4.4 長(zhǎng)度

[強(qiáng)制] 長(zhǎng)度為?0?時(shí)須省略單位。 (也只有長(zhǎng)度單位可省)

示例：

/* good */
body {
    padding: 0 5px;
}

/* bad */
body {
    padding: 0px 5px;
}

4.5 顏色

[強(qiáng)制] RGB顏色值必須使用十六進(jìn)制記號(hào)形式?#rrggbb。不允許使用?rgb()。

解釋?zhuān)?/p>

帶有alpha的顏色信息可以使用?rgba()。使用?rgba()?時(shí)每個(gè)逗號(hào)后必須保留一個(gè)空格。

示例：

/* 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);
}

[強(qiáng)制] 顏色值可以縮寫(xiě)時(shí)，必須使用縮寫(xiě)形式。

示例：

/* good */
.success {
    background-color: #aca;
}

/* bad */
.success {
    background-color: #aaccaa;
}

[強(qiáng)制] 顏色值不允許使用命名色值。

示例：

/* good */
.success {
    color: #90ee90;
}

/* bad */
.success {
    color: lightgreen;
}

[建議] 顏色值中的英文字符采用小寫(xiě)。如不用小寫(xiě)也需要保證同一項(xiàng)目?jī)?nèi)保持大小寫(xiě)一致。

示例：

/* good */
.success {
    background-color: #aca;
    color: #90ee90;
}

/* good */
.success {
    background-color: #ACA;
    color: #90EE90;
}

/* bad */
.success {
    background-color: #ACA;
    color: #90ee90;
}

4.6 2D 位置

[強(qiáng)制] 必須同時(shí)給出水平和垂直方向的位置。

解釋?zhuān)?/p>

2D 位置初始值為?0% 0%，但在只有一個(gè)方向的值時(shí)，另一個(gè)方向的值會(huì)被解析為 center。為避免理解上的困擾，應(yīng)同時(shí)給出兩個(gè)方向的值。background-position屬性值的定義

示例：

/* good */
body {
    background-position: center top; /* 50% 0% */
}

/* bad */
body {
    background-position: top; /* 50% 0% */
}

5 文本編排

5.1 字體族

[強(qiáng)制]?font-family?屬性中的字體族名稱(chēng)應(yīng)使用字體的英文?Family Name，其中如有空格，須放置在引號(hào)中。

解釋?zhuān)?/p>

所謂英文 Family Name，為字體文件的一個(gè)元數(shù)據(jù)，常見(jiàn)名稱(chēng)如下：

字體	操作系統(tǒng)	Family Name
宋體 (中易宋體)	Windows	SimSun
黑體 (中易黑體)	Windows	SimHei
微軟雅黑	Windows	Microsoft YaHei
微軟正黑	Windows	Microsoft JhengHei
華文黑體	Mac/iOS	STHeiti
冬青黑體	Mac/iOS	Hiragino Sans GB
文泉驛正黑	Linux	WenQuanYi Zen Hei
文泉驛微米黑	Linux	WenQuanYi Micro Hei

示例：

h1 {
    font-family: "Microsoft YaHei";
}

[強(qiáng)制]?font-family?按「西文字體在前、中文字體在后」、「效果佳 (質(zhì)量高/更能滿足需求) 的字體在前、效果一般的字體在后」的順序編寫(xiě)，最后必須指定一個(gè)通用字體族(?serif?/?sans-serif?)。

解釋?zhuān)?/p>

更詳細(xì)說(shuō)明可參考本文。

示例：

/* 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;
}

[強(qiáng)制]?font-family?不區(qū)分大小寫(xiě)，但在同一個(gè)項(xiàng)目中，同樣的?Family Name?大小寫(xiě)必須統(tǒng)一。

示例：

/* 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;
}

5.2 字號(hào)

[強(qiáng)制] 需要在 Windows 平臺(tái)顯示的中文內(nèi)容，其字號(hào)應(yīng)不小于?12px。

解釋?zhuān)?/p>

由于 Windows 的字體渲染機(jī)制，小于?12px?的文字顯示效果極差、難以辨認(rèn)。

5.3 字體風(fēng)格

[建議] 需要在 Windows 平臺(tái)顯示的中文內(nèi)容，不要使用除?normal?外的?font-style。其他平臺(tái)也應(yīng)慎用。

解釋?zhuān)?/p>

由于中文字體沒(méi)有?italic?風(fēng)格的實(shí)現(xiàn)，所有瀏覽器下都會(huì) fallback 到?obilique?實(shí)現(xiàn) (自動(dòng)擬合為斜體)，小字號(hào)下 (特別是 Windows 下會(huì)在小字號(hào)下使用點(diǎn)陣字體的情況下) 顯示效果差，造成閱讀困難。

5.4 字重

[強(qiáng)制]?font-weight?屬性必須使用數(shù)值方式描述。

解釋?zhuān)?/p>

CSS 的字重分 100 – 900 共九檔，但目前受字體本身質(zhì)量和瀏覽器的限制，實(shí)際上支持?400?和?700?兩檔，分別等價(jià)于關(guān)鍵詞?normal?和?bold。

瀏覽器本身使用一系列啟發(fā)式規(guī)則來(lái)進(jìn)行匹配，在?<700?時(shí)一般匹配字體的 Regular 字重，>=700?時(shí)匹配 Bold 字重。

但已有瀏覽器開(kāi)始支持?=600?時(shí)匹配 Semibold 字重 (見(jiàn)此表)，故使用數(shù)值描述增加了靈活性，也更簡(jiǎn)短。

示例：

/* good */
h1 {
    font-weight: 700;
}

/* bad */
h1 {
    font-weight: bold;
}

5.5 行高

[建議]?line-height?在定義文本段落時(shí)，應(yīng)使用數(shù)值。

解釋?zhuān)?/p>

將?line-height?設(shè)置為數(shù)值，瀏覽器會(huì)基于當(dāng)前元素設(shè)置的?font-size?進(jìn)行再次計(jì)算。在不同字號(hào)的文本段落組合中，能達(dá)到較為舒適的行間間隔效果，避免在每個(gè)設(shè)置了?font-size?都需要設(shè)置?line-height。

當(dāng)?line-height?用于控制垂直居中時(shí)，還是應(yīng)該設(shè)置成與容器高度一致。

示例：

.container {
    line-height: 1.5;
}

6 變換與動(dòng)畫(huà)

[強(qiáng)制] 使用?transition?時(shí)應(yīng)指定?transition-property。

示例：

/* good */
.box {
    transition: color 1s, border-color 1s;
}

/* bad */
.box {
    transition: all 1s;
}

[建議] 盡可能在瀏覽器能高效實(shí)現(xiàn)的屬性上添加過(guò)渡和動(dòng)畫(huà)。

解釋?zhuān)?/p>

見(jiàn)本文，在可能的情況下應(yīng)選擇這樣四種變換：

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

典型的，可以使用?translate?來(lái)代替?left?作為動(dòng)畫(huà)屬性。

示例：

/* 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 */
}

7 響應(yīng)式

[強(qiáng)制]?Media Query?不得單獨(dú)編排，必須與相關(guān)的規(guī)則一起定義。

示例：

/* Good */
/* header styles */
@media (...) {
    /* header styles */
}

/* main styles */
@media (...) {
    /* main styles */
}

/* footer styles */
@media (...) {
    /* footer styles */
}


/* Bad */
/* header styles */
/* main styles */
/* footer styles */

@media (...) {
    /* header styles */
    /* main styles */
    /* footer styles */
}

[強(qiáng)制]?Media Query?如果有多個(gè)逗號(hào)分隔的條件時(shí)，應(yīng)將每個(gè)條件放在單獨(dú)一行中。

示例：

@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 */
}

[建議] 盡可能給出在高分辨率設(shè)備 (Retina) 下效果更佳的樣式。

8 兼容性

8.1 屬性前綴

[強(qiáng)制] 帶私有前綴的屬性由長(zhǎng)到短排列，按冒號(hào)位置對(duì)齊。

解釋?zhuān)?/p>

標(biāo)準(zhǔn)屬性放在最后，按冒號(hào)對(duì)齊方便閱讀，也便于在編輯器內(nèi)進(jìn)行多行編輯。

示例：

.box {
    -webkit-box-sizing: border-box;
       -moz-box-sizing: border-box;
            box-sizing: border-box;
}

8.2 Hack

[建議] 需要添加?hack?時(shí)應(yīng)盡可能考慮是否可以采用其他方式解決。

解釋?zhuān)?/p>

如果能通過(guò)合理的 HTML 結(jié)構(gòu)或使用其他的 CSS 定義達(dá)到理想的樣式，則不應(yīng)該使用 hack 手段解決問(wèn)題。通常 hack 會(huì)導(dǎo)致維護(hù)成本的增加。

[建議] 盡量使用?選擇器 hack?處理兼容性，而非?屬性 hack。

解釋?zhuān)?/p>

盡量使用符合 CSS 語(yǔ)法的 selector hack，可以避免一些第三方庫(kù)無(wú)法識(shí)別 hack 語(yǔ)法的問(wèn)題。

示例：

/* IE 7 */
*:first-child + html #header {
    margin-top: 3px;
    padding: 5px;
}

/* IE 6 */
* html #header {
    margin-top: 5px;
    padding: 4px;
}

[建議] 盡量使用簡(jiǎn)單的?屬性 hack。

示例：

.box {
    _display: inline; /* fix double margin */
    float: left;
    margin-left: 20px;
}

.container {
    overflow: hidden;
    *zoom: 1; /* triggering hasLayout */
}

8.3 Expression

[強(qiáng)制] 禁止使用?Expression。