編寫靈活、穩定、高質量的前端程式碼的規範二(推薦收藏)
編寫靈活、穩定、高質量的HTML程式碼的規範二
一、程式碼組織
1.1 注意
(1)以元件為單位組織程式碼段。
(2)制定一致的註釋規範。
(3)使用一致的空白符將程式碼分隔成塊,這樣利於掃描較大的文件。
(4)如果使用了多個 CSS 檔案,將其按照元件而非頁面的形式分拆,因為頁面會被重組,而元件只會被移動。
1.2 Example
二、宣告順序
2.1 相關屬性一組
相關的屬性宣告應當歸為一組,並按照下面的順序排列:
(1)Positioning(元素位置)
(2)Box model(盒子模型)
(3)Typographic(排版)
(4)Visual(UI)
2.2 說明
(1)由於定位(positioning)可以從正常的文件流中移除元素,並且還能覆蓋盒模型(box model)相關的樣式,因此排在首位。
(2)盒模型排在第二位,因為它決定了元件的尺寸和位置。
(3)其他屬性只是影響元件的內部(inside)或者是不影響前兩組屬性,因此排在後面。
2.3 Example
三、不要使用 @import
3.1 不用原因
與 <link>
標籤相比,@import 指令要慢很多,不光增加了額外的請求次數,還會導致不可預料的問題。
這裡只是說不要用@import
代替link
引入css,而我們現在模組化開發,很多地方都有使用require
和import
.
至於兩者的區別,require
方法是CommonJs推出的,NodeJs自帶了這個功能。而import
是ES6推出的,babel
執行的時候會把ES6語法(import)轉換成CommonJs規範
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)的值,因此,在必要的時候,只需覆蓋這兩個值就可以。過度使用簡寫形式的屬性宣告會導致程式碼混亂,並且會對屬性值帶來不必要的覆蓋從而引起意外的副作用。
八、Less 和 Sass 中的巢狀
8.1 儘量不巢狀
避免不必要的巢狀。這是因為雖然你可以使用巢狀,但是並不意味著應該使用巢狀。只有在必須將樣式限制在父元素內(也就是後代選擇器),並且存在多個需要巢狀的元素時才使用巢狀。
8.2 Example
九、Less 和 Sass 中的操作符
為了提高可讀性,在圓括號中的數學計算表示式的數值、變數和操作符之間均新增一個空格。
十、註釋
10.1 注意
程式碼是由人編寫並維護的。請確保你的程式碼能夠自描述、註釋良好並且易於他人理解。好的程式碼註釋能夠傳達上下文關係和程式碼目的。不要簡單地重申元件或 class 名稱。
對於較長的註釋,務必書寫完整的句子;對於一般性註解,可以書寫簡潔的短語。
十一、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 變數命名時也可以參考上面列出的各項規範。
十二、選擇器
12.1 注意
(1)對於通用元素使用 class ,這樣利於渲染效能的優化。
(2)對於經常出現的元件,避免使用屬性選擇器(例如,[class^="..."])。瀏覽器的效能會受到這些因素的影響。
(3)選擇器要儘可能短,並且儘量限制組成選擇器的元素個數,建議不要超過 3 。
(4)只有在必要的時候才將 class 限制在最近的父元素內(也就是後代選擇器)(例如,不使用帶字首的 class 時 -- 字首類似於名稱空間)。
12.2 Example
十四、編輯器配置
14.1 避免程式碼不同
將你的編輯器按照下面的配置進行設定,以避免常見的程式碼不一致和差異:
(1)用兩個空格代替製表符(soft-tab 即用空格代表 tab 符)。
(2)儲存檔案時,刪除尾部的空白符。
(3)設定檔案編碼為 UTF-8。
(4)在檔案結尾新增一個空白行。