CSS樣式書寫規(guī)范
可能不同團(tuán)隊(duì)都有各自的規(guī)范，又或者很多人在寫 CSS 的時(shí)候還是想到什么就寫什么，不存在太多的約束。
我覺得 CSS 代碼規(guī)范還是有存在的必要的，尤其是在團(tuán)隊(duì)配合，多人協(xié)作下，規(guī)范就顯得尤為重要。
本文的所列是實(shí)踐當(dāng)中得出的一套比較不錯(cuò)的 CSS 書寫規(guī)范，并不希望大家完全采用，而是希望可以結(jié)合自己的團(tuán)隊(duì)需要，發(fā)展出一套適合自己的 CSS 代碼規(guī)范。
也希望可以有更多的建議，共同的完善。本規(guī)范也可以在我的 Github 上看到，歡迎留言或者提 PR。
我覺得不同的規(guī)范都有各自的長處與缺陷，對(duì)待所謂的規(guī)范最好的方式不是人云亦云，拿來就用，而是應(yīng)該結(jié)合實(shí)際情況及需求，取長補(bǔ)短，取其精華去其糟粕。
編碼設(shè)置
采用 UTF-8 編碼，在 CSS 代碼頭部使用：
- @charset "utf-8";
注意，必須要定義在 CSS 文件所有字符的前面(包括編碼注釋)，@charset 才會(huì)生效。
例如，下面的例子都會(huì)使得 @charset 失效：
- /* 字符編碼 */
- @charset "utf-8";
- html,
- body {
- height: 100%;
- }
- @charset "utf-8";
命名空間規(guī)范
- 布局：以 g 為命名空間，例如：.g-wrap 、.g-header、.g-content。
- 狀態(tài)：以 s 為命名空間，表示動(dòng)態(tài)的、具有交互性質(zhì)的狀態(tài)，例如：.s-current、s-selected。
- 工具：以 u 為命名空間，表示不耦合業(yè)務(wù)邏輯的、可復(fù)用的的工具，例如：u-clearfix、u-ellipsis。
- 組件：以 m 為命名空間，表示可復(fù)用、移植的組件模塊，例如：m-slider、m-dropMenu。
- 鉤子：以 j 為命名空間，表示特定給 JavaScript 調(diào)用的類名，例如：j-request、j-open。
命名空間思想
沒有選擇 BEM 這種命名過于嚴(yán)苛及樣式名過長過丑的規(guī)則，采取了一種比較折中的方案。
不建議使用下劃線 _ 進(jìn)行連接
- 節(jié)省操作，輸入的時(shí)候少按一個(gè) shift 鍵
- 能良好區(qū)分 JavaScript 變量命名
字符小寫
定義的選擇器名，屬性及屬性值的書寫皆為小寫。
選擇器
當(dāng)一個(gè)規(guī)則包含多個(gè)選擇器時(shí)，每個(gè)選擇器獨(dú)占一行。
、+、~、> 選擇器的兩邊各保留一個(gè)空格。
- .g-header > .g-header-des,
- .g-content ~ .g-footer {
命名短且語義化良好
對(duì)于選擇器的命名，盡量簡潔且具有語義化，不應(yīng)該出現(xiàn) g-abc 這種語義模糊的命名。
規(guī)則聲明塊
- 當(dāng)規(guī)則聲明塊中有多個(gè)樣式聲明時(shí)，每條樣式獨(dú)占一行。
- 在規(guī)則聲明塊的左大括號(hào) { 前加一個(gè)空格。
- 在樣式屬性的冒號(hào) : 后面加上一個(gè)空格，前面不加空格。
- 在每條樣式后面都以分號(hào) ; 結(jié)尾。
- 規(guī)則聲明塊的右大括號(hào) } 獨(dú)占一行。
- 每個(gè)規(guī)則聲明間用空行分隔。
- 所有最外層引號(hào)使用單引號(hào) ‘ 。
- 當(dāng)一個(gè)屬性有多個(gè)屬性值時(shí)，以逗號(hào) , 分隔屬性值，每個(gè)逗號(hào)后添加一個(gè)空格，當(dāng)單個(gè)屬性值過長時(shí)，每個(gè)屬性值獨(dú)占一行。
完整示例如下：
- .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: '';
- }
數(shù)值與單位
- 當(dāng)屬性值或顏色參數(shù)為 0 – 1 之間的數(shù)時(shí)，省略小數(shù)點(diǎn)前的 0 。color: rgba(255, 255, 255, 0.5)color: rgba(255, 255, 255, .5);
- 當(dāng)長度值為 0 時(shí)省略單位。margin: 0px automargin: 0 auto
- 十六進(jìn)制的顏色屬性值使用小寫和盡量簡寫。color: #ffcc00color: #fc0
樣式屬性順序
單個(gè)樣式規(guī)則下的屬性在書寫時(shí)，應(yīng)按功能進(jìn)行分組，并以 Positioning Model > Box Model > Typographic > Visual 的順序書寫，提高代碼的可讀性。
- 如果包含 content 屬性，應(yīng)放在最前面;
- Positioning Model 布局方式、位置，相關(guān)屬性包括：position / top / right / bottom / left / z-index / display / float / …
- Box Model 盒模型，相關(guān)屬性包括：width / height / padding / margin / border / overflow / …
- Typographic 文本排版，相關(guān)屬性包括：font / line-height / text-align / word-wrap / …
- Visual 視覺外觀，相關(guān)屬性包括：color / background / list-style / transform / animation / transition / …
Positioning 處在第一位，因?yàn)樗梢允挂粋€(gè)元素脫離正常文本流，并且覆蓋盒模型相關(guān)的樣式。盒模型緊跟其后，因?yàn)樗麤Q定了一個(gè)組件的大小和位置。其他屬性只在組件內(nèi)部起作用或者不會(huì)對(duì)前面兩種情況的結(jié)果產(chǎn)生影響，所以他們排在后面。
合理使用使用引號(hào)
在某些樣式中，會(huì)出現(xiàn)一些含有空格的關(guān)鍵字或者中文關(guān)鍵字。
font-family 內(nèi)使用引號(hào)
當(dāng)字體名字中間有空格，中文名字體及 Unicode 字符編碼表示的中文字體，為了保證兼容性，都建議在字體兩端添加單引號(hào)或者雙引號(hào)：
- body {
- font-family: 'Microsoft YaHei', '黑體-簡', '\5b8b\4f53';
- }
background-image 的 url 內(nèi)使用引號(hào)
如果路徑里面有空格，舊版 IE 是無法識(shí)別的，會(huì)導(dǎo)致路徑失效，建議不管是否存在空格，都添加上單引號(hào)或者雙引號(hào)：
- div {
- background-image: url('...');
- }
避免使用 !important
除去某些極特殊的情況，盡量不要不要使用 !important。
!important 的存在會(huì)給后期維護(hù)以及多人協(xié)作帶來噩夢(mèng)般的影響。
當(dāng)存在樣式覆蓋層疊時(shí)，如果你發(fā)現(xiàn)新定義的一個(gè)樣式無法覆蓋一個(gè)舊的樣式，只有加上 !important 才能生效時(shí)，是因?yàn)槟阈露x的選擇器的優(yōu)先級(jí)不夠舊樣式選擇器的優(yōu)先級(jí)高。所以，合理的書寫新樣式選擇器，是完全可以規(guī)避一些看似需要使用 !important 的情況的。
代碼注釋
單行注釋
星號(hào)與內(nèi)容之間必須保留一個(gè)空格。
- /* 表格隔行變色 */
多行注釋
星號(hào)要一列對(duì)齊，星號(hào)與內(nèi)容之間必須保留一個(gè)空格。
- /**
- * Sometimes you need to include optional context for the entire component. Do that up here if it's important enough.
- */
規(guī)則聲明塊內(nèi)注釋
使用 // 注釋，// 后面加上一個(gè)空格，注釋獨(dú)立一行。
- .g-footer {
- border: 0;
- // ....
- }
文件注釋
文件頂部必須包含文件注釋，用 @name 標(biāo)識(shí)文件說明。星號(hào)要一列對(duì)齊，星號(hào)與內(nèi)容之間必須保留一個(gè)空格，標(biāo)識(shí)符冒號(hào)與內(nèi)容之間必須保留一個(gè)空格。
- /**
- * @name: 文件名或模塊名
- * @description: 文件或模塊描述
- * @author: author-name(mail-name@domain.com)
- * author-name2(mail-name2@domain.com)
- * @update: 2015-04-29 00:02
- */
- @description為文件或模塊描述。
- @update為可選項(xiàng)，建議每次改動(dòng)都更新一下。
當(dāng)該業(yè)務(wù)項(xiàng)目主要由固定的一個(gè)或多個(gè)人負(fù)責(zé)時(shí)，需要添加@author標(biāo)識(shí)，一方面是尊重勞動(dòng)成果，另一方面方便在需要時(shí)快速定位責(zé)任人。
SASS 使用建議
嵌套層級(jí)規(guī)定
使用 SASS 、 LESS 等預(yù)處理器時(shí)，建議嵌套層級(jí)不超過 3 層。
組件/公用類的使用方法
組件/公用類使用 %placeholders 定義，使用 @extend 引用。如：
- %clearfix {
- overflow: auto;
- zoom: 1;
- }
- .g-header {
- @extend %clearfix;
- }
組件類的思考
使用 SASS ，經(jīng)常會(huì)預(yù)先定義好一些常用公用組件類，譬如清除浮動(dòng)，水平垂直居中，文字 ellipsis。又或者多個(gè)元素具有同樣的樣式，我們希望能夠少寫這部分代碼，公共部分抽離出來只寫一次，達(dá)到復(fù)用。
但是復(fù)用的方式在 SASS 中有多種，那么是使用單獨(dú)使用一個(gè)類定義，給需要的標(biāo)簽添加，還是使用 @include 或者 @extend在定義的類中引入一個(gè) @mixin，或者一個(gè) @function 呢?
基于讓 CSS 更簡潔以及代碼的復(fù)用考慮，采用上面的使用 %placeholders 定義，使用 @extend 引用的方案。
- %placeholders，只是一個(gè)占位符，只要不通過 @extend 調(diào)用，編譯后不會(huì)產(chǎn)生任何代碼量
- 使用 @extend 引用，則是因?yàn)槊看握{(diào)用相同的 %placeholders 時(shí)，編譯出來相同的 CSS 樣式會(huì)進(jìn)行合并(反之，如果使用 @include 調(diào)用定義好的 @mixin，編譯出來相同的 CSS 樣式不會(huì)進(jìn)行合并)
- 這里的組件類特指那些不會(huì)動(dòng)態(tài)改變的 CSS 樣式，注意與那些可以通過傳參生成不同數(shù)值樣式的 @mixin 方法進(jìn)行區(qū)分
盡量避免使用標(biāo)簽名
使用 SASS ，或者說在 CSS 里也有這種困惑。
假設(shè)我們有如下 html 結(jié)構(gòu)：
- <span>
- <div class="g-content">
- <ul class="g-content-list"><li class="item"/>
- <li class="item"/>
- <li class="item"/>
- <li class="item"/>
- </ul></div>
- </span>
在給最里層的標(biāo)簽命名書寫樣式的時(shí)候，我們有兩種選擇：
- .g-content {
- .g-content-list {
- li {
- ...
- }
- }
- }
或者是
- .g-content {
- .g-content-list {
- .item {
- ...
- }
- }
- }
也就是，編譯之后生成了下面這兩個(gè)，到底使用哪個(gè)好呢?
- .g-content .g-content-list li { }
- .g-content .g-content-list .item { }
基于 CSS 選擇器的解析規(guī)則(從右向左)，建議使用上述第二種 .g-content .g-content-list .item { } ，避免使用通用標(biāo)簽名作為選擇器的一環(huán)可以提高 CSS 匹配性能。
瀏覽器的排版引擎解析 CSS 是基于從右向左(right-to-left)的規(guī)則，這么做是為了使樣式規(guī)則能夠更快地與渲染樹上的節(jié)點(diǎn)匹配。
本規(guī)范也可以在我的 Github (https://github.com/chokcoco/CSSWritingRules)上看到，歡迎留言或者提 PR。
