CSS編碼規范

1 代碼風格

1.1 文件

[建議] css使用無BOMUTF-8編碼。

解釋:
UTF-8 編碼具有更廣泛的適應性。BOM在使用程序或工具處理文件是可能造成不必要的干擾。

1.2 縮進

[強制] 使用4個空格座位一個縮進層級,不允許使用2個空格或者tab字符。

示例:

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

1.3 空格

[強制] 屬性名于之后的:之間不允許包含空格,:屬性值之間必須包含空格。

示例:

margin: 0;
[強制] 列表性屬性值書寫在單行是,后必須跟一個空格。

示例:

font-family: Arial, sans-serif;

1.4 行長度

[強制] 每行不超過120個字符,除非單行不可分割。

解釋:
常見不可分割的場景為URL超長。

[建議] 對于超長的樣紙,在樣式值的 空格處或,后換行,建議按邏輯分組。

示例:

/* 不同屬性值按邏輯分組 */
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))
);

1.5 選擇器

[強制] 當一個rule包含多個selector時,每個選擇器聲明必須獨占一行。

示例:

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

[強制] 屬性選擇器中的值必須用雙引號包圍。

解釋:
不允許使用單引號,不允許不使用引號。

示例:

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

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

1.6 屬性

[強制] 屬性定義必須另起一行。

示例:

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

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

[強制] 屬性定義后必須以分號結尾。

示例:

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

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

2 通用

2.1 選擇器

[強制] 如無必要,不得為idclass選擇器添加類型選擇器進行限定。

解釋:
在性能和維護性上,都有一定得影響。

示例:

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

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

[建議] 選擇器 的嵌套層級應不大于3級,位置靠后的限定條件應盡可能精確。

示例:

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

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

2.2 屬性縮寫

[建議] 在可以使用所寫的情況下,盡可能使用縮寫。

示例:

/* 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等縮寫時,應注意隱含值對實際數值的影響,確實需要設置多個方向的值時才使用縮寫。

解釋:border/margin/padding 等縮寫會同時設置多個屬性的值,容易覆蓋不需要覆蓋的設定。如某些方向需要繼承其他聲明的值,則應該分開設置。

示例:

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

2.3 屬性書寫順序

[建議] 同一rule set下的屬性在書寫時,應按功能進行分組,并以Formatting Model 的順序書寫,以提高代碼的可讀性。

解釋:

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

另外,如果包含 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;
}

2.4 清除浮動

[建議] 當元素需要撐起高度以及包含內部的浮動元素時,通過的偽類設置clear 或觸發bfc的方式進行clearfix。盡量不要使用增加空標簽的方式。

實例

解釋:
觸發BFC的方式很多,常見的有:

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

如果希望使用更小的清楚浮動方法,參見 A new micro clearfix hack 一文。
另需注意,對已經觸發BFC的元素不需要在進行clearfix。

2.5 !important

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

[建議] 當需要強制指定樣式且不允許任何場景覆蓋時,通過標簽內聯和!important定義樣式。

解釋:
必須注意的是,僅在設計上確實不允許任何其他場景覆蓋樣式時,才使用內聯的!important樣式。通常在第三方環境的應用中使用這種方案。下面的z-index章節是其中一個特殊場景的典型樣例。

2.6 z-index

[建議] 將z-index進行分層,對文檔流外絕對定位元素的視覺層級關系進行管理。

解釋:

同層的多個元素,如多個由用戶輸入觸發的Dialog,在該層級內使用相同的z-index或遞增z-index
建議每層包含100個z-index來容納足夠的元素,如果每層元素較多,可以調整這個數值。

[建議] 在可控的環境下,期望顯示在最上面的元素,z-index指定為999999

解釋:
可控環分為兩種,一種 是自身產品線環境,還有一種是可能會被其他產品線引用,但是不會被外部第三方的產品引用。

不建議取值為2137483647。以便于自身產品線被其他產品線引用時,當遇到層級覆蓋沖突的情況,留出向上調節的空間。

[建議] 在第三方環境下,期望顯示在最上層的元素,通過標簽內聯和!important,將z-index指定為21483647

解釋:
第三方環境對于開發者來說完全不可控。在第三方環境在的元素,為了保證元素不被其頁面其他樣式定義覆蓋,需要采用此做法。

3 值與單位

3.1 文本

[強制] 文本內容必須用雙引號包圍。

解釋:
文本類型的內容可能在選擇器、屬性值等內容中。

示例:

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

3.2 數值

[強制] 當數值為0-1之間的小數時,不能省略整數部分的0

示例:

/* good */
panel {
    opacity: 0.8
}

/* bad */
panel {
    opacity: .8
}

3.3 url()

[強制] url() 函數的路徑不加引號。

示例:

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

[建議] url()函數中的絕對路徑可省去協議名。

示例:

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

3.4 長度

[強制] 長度為0時必須省略單位,(也只有長度單位可省)

示例:

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

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

3.5 顏色

[強制] 顏色值可以縮寫時,不準使用縮寫形式。

示例:

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

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

[強制] 顏色值中的英文字符采用小寫。

示例:

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


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

3.6 2D位置

[強制] 必須同時給出水平和垂直方向的位置。

解釋:

2D 位置初始值為 0% 0%,但在只有一個方向的值時,另一個方向的值會被解析為 center。為避免理解上的困擾,應同時給出兩個方向的值。background-position屬性值的定義

示例:

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

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

4 文本編排

4.1 字號

[強制] 需要在windows平臺顯示的中文內容,其字號應不小于12px

解釋:
由于windows 的習題渲染機制,小于12px的文字顯示效果極差、難以辨認。

4.2 字體風格

[建議] 需要在windows平臺顯示的中文內容,不要使用除normal外的font-style。其他平臺也應慎用。

解釋:
由于中文字體沒有italic風格的實現,所有瀏覽器下都會fallback到obilique實現(自動擬合為斜體),小字號下,(特別是windows下會在小字號下使用點陣字體的情況下)顯示效果差,造成閱讀困難。

4.3 字重

[強制] font-weight屬性必須使用數值方式描述。

解釋:

CSS 的字重分 100 – 900 共九檔,但目前受字體本身質量和瀏覽器的限制,實際上支持 400 和 700 兩檔,分別等價于關鍵詞 normal 和 bold。

瀏覽器本身使用一系列啟發式規則來進行匹配,在 <700 時一般匹配字體的 Regular 字重,>=700 時匹配 Bold 字重。

但已有瀏覽器開始支持 =600 時匹配 Semibold 字重 (見此表),故使用數值描述增加了靈活性,也更簡短。

示例:

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

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

4.4 行高

[建議] line-height在定義的文本段落時,應使用數值。

解釋:
將 line-height 設置為數值,瀏覽器會基于當前元素設置的 font-size 進行再次計算。在不同字號的文本段落組合中,能達到較為舒適的行間間隔效果,避免在每個設置了 font-size 都需要設置 line-height。

當 line-height 用于控制垂直居中時,還是應該設置成與容器高度一致。

示例:

.container {
    line-height: 1.5;
}

5 變換與動畫

[強制] 使用transition時應制定transition-property

示例:

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

6 響應式

[強制] Media Query 不得單獨編排,必須與相關的規則一起定義。

示例:

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

[強制] Media Query 如果有多個逗號分隔的條件時,應將每個條件放在單獨一行中。

示例:

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

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

7 兼容性

[強制] 帶私有前綴的屬性由長到短排列,按冒號位置對齊。

解釋:

標準屬性放在最后,按冒號對齊方便閱讀,也便于在編輯器內進行多行編輯。

示例:

.box {
    -webkit-box-sizing: border-box;
       -moz-box-sizing: border-box;
            box-sizing: border-box;
}
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • CSS編碼規范 1 前言 CSS 作為網頁樣式的描述語言,在百度一直有著廣泛的應用。本文檔的目標是使 CSS 代碼...
    Top_Chenxi閱讀 168評論 0 0
  • CSS編碼規范 1 前言 CSS作為網頁樣式的描述語言,在百度一直有著廣泛的應用。本文檔的目標是使CSS代碼風格保...
    春木橙云閱讀 293評論 0 0
  • 原文: https://github.com/ecomfe/spec/blob/master/javascript...
    zock閱讀 3,408評論 2 36
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具(例如配置管理,服務發現,斷路器,智...
    卡卡羅2017閱讀 134,948評論 18 139
  • 一、我們有沒有進入機器人的時代 我們先看看下面三則事件 2011年,富士康對外公布了百萬機器人計劃,計劃在產業園區...
    兩閱鵬閱讀 482評論 0 0