編寫靈活、穩定、高質量的CSS程式碼的規範（推薦收藏）

一、唯一定律

無論有多少人共同參與同一專案，一定要確保每一行程式碼都像是唯一個人編寫的。

二、HTML

2.1 語法

（1）用兩個空格來代替製表符（tab） — 這是唯一能保證在所有環境下獲得一致展現的方法。

（2）巢狀元素應當縮排一次（即兩個空格）。

（3）對於屬性的定義，確保全部使用雙引號，絕不要使用單引號。

（4）不要在自閉合（self-closing）元素的尾部新增斜線 — HTML5 規範中明確說明這是可選的。

（5）不要省略可選的結束標籤（closing tag）（例如，</li> 或 </body>）。

2.2 Example

三、HTML5 doctype

為每個 HTML 頁面的第一行新增標準模式（standard mode）的宣告，這樣能夠確保在每個瀏覽器中擁有一致的展現。

四、語言屬性

根據 HTML5 規範：

強烈建議為 html 根元素指定 lang 屬性，從而為文件設定正確的語言。這將有助於語音合成工具確定其所應該採用的發音，有助於翻譯工具確定其翻譯時所應遵守的規則等等。

五、IE 相容模式

IE 支援通過特定的 <meta> 標籤來確定繪製當前頁面所應該採用的 IE 版本。除非有強烈的特殊需求，否則最好是設定為 edge mode，從而通知 IE 採用其所支援的最新的模式。

六、字元編碼

通過明確宣告字元編碼，能夠確保瀏覽器快速並容易的判斷頁面內容的渲染方式。這樣做的好處是，可以避免在 HTML 中使用字元實體標記（character entity），從而全部與文件編碼一致（一般採用 UTF-8 編碼）。

七、引入 CSS 和 JavaScript 檔案

根據 HTML5 規範，在引入 CSS 和 JavaScript 檔案時一般不需要指定 type 屬性，因為 text/css 和 text/javascript 分別是它們的預設值。

八、實用為王

儘量遵循 HTML 標準和語義，但是不要以犧牲實用性為代價。任何時候都要儘量使用最少的標籤並保持最小的複雜度。

九、屬性順序

9.1 從大到小

HTML 屬性應當按照以下給出的順序依次排列，確保程式碼的易讀性。

（1）class

（2）id, name

（3）data-*

（4）src, for, type, href, value

（5）title, alt

（6）role, aria-*

9.2 Example

9.3 說明

class 用於標識高度可複用元件，因此應該排在首位。id 用於標識具體元件，應當謹慎使用（例如，頁面內的書籤），因此排在第二位。

十、布林（boolean）型屬性

10.1 注意

（1）布林型屬性可以在宣告時不賦值。XHTML 規範要求為其賦值，但是 HTML5 規範不需要。

（2）元素的布林型屬性如果有值，就是 true，如果沒有值，就是 false。

（3）如果屬性存在，其值必須是空字串或 […] 屬性的規範名稱，並且不要在首尾新增空白符。

簡單來說，就是不用賦值。

10.2 Example

十一、減少標籤的數量

編寫 HTML 程式碼時，儘量避免多餘的父元素。很多時候，這需要迭代和重構來實現。

十二、減少 JavaScript 生成的標籤

通過 JavaScript 生成的標籤讓內容變得不易查詢、編輯，並且降低效能。能避免時儘量避免。

編寫靈活、穩定、高質量的CSS程式碼的規範

一、語法

1.1 注意

（1）用兩個空格來代替製表符（tab） — 這是唯一能保證在所有環境下獲得一致展現的方法。

（2）為選擇器分組時，將單獨的選擇器單獨放在一行。

（3）為了程式碼的易讀性，在每個宣告塊的左花括號前新增一個空格。

（4）宣告塊的右花括號應當單獨成行。

（5）每條宣告語句之後應該插入一個空格。

（6）為了獲得更準確的錯誤報告，每條宣告都應該獨佔一行。

（7）所有宣告語句都應當以分號結尾。最後一條宣告語句後面的分號是可選的，但是，如果省略這個分號，你的程式碼可能更易出錯。

（8）對於以逗號分隔的屬性值，每個逗號後面都應該插入一個空格（例如 ，box-shadow）。

（9）不要在 rgb()、rgba()、hsl()、hsla() 或 rect() 值的內部的逗號後面插入空格。這樣利於從多個屬性值（既加逗號也加空格）中區分多個顏色值（只加逗號，不加空格）。

（10）對於屬性值或顏色引數，省略小於 1 的小數前面的 0 （例如，.5 代替 0.5；-.5px 代替 -0.5px）。

（11）十六進位制值應該全部小寫，例如，#fff。在掃描文件時，小寫字元易於分辨，因為他們的形式更易於區分。

（12）儘量使用簡寫形式的十六進位制值，例如，用 #fff 代替 #ffffff。

（13）為選擇器中的屬性新增雙引號，例如，input[type=”text”]。只有在某些情況下是可選的，但是，為了程式碼的一致性，建議都加上雙引號。

（14）避免為 0 值指定單位，例如，用 margin: 0; 代替 margin: 0px;。

1.2 Example

二、宣告順序

2.1 相關屬性一組

相關的屬性宣告應當歸為一組，並按照下面的順序排列：

（1）Positioning

（2）Box model

（3）Typographic

（4）Visual

2.2 說明

（1）由於定位（positioning）可以從正常的文件流中移除元素，並且還能覆蓋盒模型（box model）相關的樣式，因此排在首位。

（2）盒模型排在第二位，因為它決定了元件的尺寸和位置。

（3）其他屬性只是影響元件的內部（inside）或者是不影響前兩組屬性，因此排在後面。

2.3 Example

三、不要使用 @import

3.1 不用原因

與 <link> 標籤相比，@import 指令要慢很多，不光增加了額外的請求次數，還會導致不可預料的問題。

3.2替代方法

（1）使用多個 <link> 元素

（2）通過 Sass 或 Less 類似的 CSS 前處理器將多個 CSS 檔案編譯為一個檔案

（3）通過 Rails、Jekyll 或其他系統中提供過 CSS 檔案合併功能

3.3 Example

四、媒體查詢（Media query）的位置

4.1 相關規則附近

將媒體查詢放在儘可能相關規則的附近。不要將他們打包放在一個單一樣式檔案中或者放在文件底部。如果你把他們分開了，將來只會被大家遺忘。

4.2 Example

五、帶字首的屬性

5.1 垂直對齊

當使用特定廠商的帶有字首的屬性時，通過縮排的方式，讓每個屬性的值在垂直方向對齊，這樣便於多行編輯。

5.2 Example

六、單行規則宣告

6.1 放在一行

對於只包含一條宣告的樣式，為了易讀性和便於快速編輯，建議將語句放在同一行。對於帶有多條宣告的樣式，還是應當將宣告分為多行。

6.2 錯誤檢測

這樣做的關鍵因素是為了錯誤檢測 — 例如，CSS 校驗器指出在 100 行有語法錯誤。如果是單行單條宣告，你就不會忽略這個錯誤；如果是單行多條宣告的話，你就要仔細分析避免漏掉錯誤了。

6.3 Example

七、簡寫形式的屬性宣告7.1 濫用簡寫

在需要顯示地設定所有值的情況下，應當儘量限制使用簡寫形式的屬性宣告。常見的濫用簡寫屬性宣告的情況如下：

（1）padding

（2）margin

（3）font

（4）background

（5）border

（5）border-radius

7.2 說明

大部分情況下，我們不需要為簡寫形式的屬性宣告指定所有值。例如，HTML 的 heading 元素只需要設定上、下邊距（margin）的值，因此，在必要的時候，只需覆蓋這兩個值就可以。過度使用簡寫形式的屬性宣告會導致程式碼混亂，並且會對屬性值帶來不必要的覆蓋從而引起意外的副作用。

7.3 Example

八、Less 和 Sass 中的巢狀

8.1 儘量不巢狀

避免不必要的巢狀。這是因為雖然你可以使用巢狀，但是並不意味著應該使用巢狀。只有在必須將樣式限制在父元素內（也就是後代選擇器），並且存在多個需要巢狀的元素時才使用巢狀。

8.2 Example

九、Less 和 Sass 中的操作符

為了提高可讀性，在圓括號中的數學計算表示式的數值、變數和操作符之間均新增一個空格。

十、註釋

10.1 注意

程式碼是由人編寫並維護的。請確保你的程式碼能夠自描述、註釋良好並且易於他人理解。好的程式碼註釋能夠傳達上下文關係和程式碼目的。不要簡單地重申元件或 class 名稱。

對於較長的註釋，務必書寫完整的句子；對於一般性註解，可以書寫簡潔的短語。

10.2 Example

十一、class 命名

11.1 規範

（1）class 名稱中只能出現小寫字元和破折號（dashe）（不是下劃線，也不是駝峰命名法）。破折號應當用於相關 class 的命名（類似於名稱空間）（例如，.btn 和 .btn-danger）。

（2）避免過度任意的簡寫。.btn 代表 button，但是 .s 不能表達任何意思。

（3）class 名稱應當儘可能短，並且意義明確。

（4）使用有意義的名稱。使用有組織的或目的明確的名稱，不要使用表現形式（presentational）的名稱。

（5）基於最近的父 class 或基本（base） class 作為新 class 的字首。

（6）使用 .js-* class 來標識行為（與樣式相對），並且不要將這些 class 包含到 CSS 檔案中。

在為 Sass 和 Less 變數命名時也可以參考上面列出的各項規範。

11.2 Example

十二、選擇器12.1 注意

（1）對於通用元素使用 class ，這樣利於渲染效能的優化。

（2）對於經常出現的元件，避免使用屬性選擇器（例如，[class^=”…”]）。瀏覽器的效能會受到這些因素的影響。

（3）選擇器要儘可能短，並且儘量限制組成選擇器的元素個數，建議不要超過 3 。

（4）只有在必要的時候才將 class 限制在最近的父元素內（也就是後代選擇器）（例如，不使用帶字首的 class 時 — 字首類似於名稱空間）。

12.2 Example

十三、程式碼組織

13.1 注意

（1）以元件為單位組織程式碼段。

（2）制定一致的註釋規範。

（3）使用一致的空白符將程式碼分隔成塊，這樣利於掃描較大的文件。

（4）如果使用了多個 CSS 檔案，將其按照元件而非頁面的形式分拆，因為頁面會被重組，而元件只會被移動。

13.2 Example

十四、編輯器配置

14.1 避免程式碼不同

將你的編輯器按照下面的配置進行設定，以避免常見的程式碼不一致和差異：

（1）用兩個空格代替製表符（soft-tab 即用空格代表 tab 符）。

（2）儲存檔案時，刪除尾部的空白符。

（3）設定檔案編碼為 UTF-8。

（4）在檔案結尾新增一個空白行。

原文釋出時間為：2018-09-4

本文作者：WEBING

本文來自雲棲社群合作伙伴“前端大學”，瞭解相關資訊可以關注“前端大學”。