不管有多少人共同參與同一項目,一定要確保每一行程式碼都像是由同一個人寫的。
1.用兩個空格來代替製表符(tab) – 這是唯一能保證在所有環境下獲得一致展現的方法。
2.嵌套元素應縮排一次(即兩個空格)。
3.對於屬性的定義,確保全部使用雙引號,絕對不要使用單引號。
4.不要在自閉合(self-closing)元素的尾部添加斜線– HTML5 規範中明確說明這是可選的。
5.不要省略可選的結束標籤(closing tag)
<!DOCTYPE html> <html> <head> <title>Page title</title> </head> <body> <img src="images/company-logo.png" alt="Company"> <h1 class="hello-world">Hello, world!</h1> </body> </html>
為每個HTML 頁面的第一行添加標準模式(standard mode)的聲明,這樣能夠確保在每個瀏覽器中擁有一致的展現。
<!DOCTYPE html> <html> <head> </head> </html>
根據HTML5 規範:
強烈建議為html 根元素指定lang 屬性,從而為文件設定正確的語言。這將有助於語音合成工具確定其所應該採用的發音,有助於翻譯工具確定其翻譯時所應遵守的規則等等。
<html lang="en-us"> <!-- ... --> </html>
IE 支援透過特定的標籤來決定繪製目前頁面所應該採用的IE 版本。除非有強烈的特殊需求,否則最好是設定為edge mode,從而通知IE 採用其所支援的最新的模式。
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
透過明確聲明字元編碼,能夠確保瀏覽器快速且容易的判斷頁面內容的渲染方式。這樣做的好處是,可以避免在HTML 中使用字元實體標記(character entity),從而全部與文件編碼一致(一般採用UTF-8 編碼)。
<head> <meta charset="UTF-8"> </head>
根據HTML5 規範,在引入CSS 和JavaScript 檔案時一般不需要指定type 屬性,因為text/css 和text/javascript 分別是它們的預設值。
<!-- External CSS --> <link rel="stylesheet" href="code-guide.css"> <!-- In-document CSS --> <style> /* ... */ </style> <!-- JavaScript --> <script src="code-guide.js"></script>
盡量遵循HTML 標準和語義,但不要以犧牲實用性為代價。任何時候都要盡量使用最少的標籤並保持最小的複雜度。
HTML 屬性應依照下列所給的順序依序排列,確保程式碼的易讀性。
class
id, name
data-*
src, for, type, href, value
title, alt
role, aria-*
class 用於標識高度可重複使用組件,因此應排在首位。 id 用於標識具體組件,應謹慎使用(例如,頁內的書籤),因此排在第二位。
布林型屬性可以在聲明時不賦值。 XHTML 規格要求為其賦值,但HTML5 規格不需要。
更多資訊請參考WhatWG section on boolean attributes:
元素的布林型屬性如果有值,就是true,如果沒有值,就是false。
如果一定要為其賦值的話,請參考WhatWG 規格:
如果屬性存在,其值必須是空字串或[…] 屬性的規範名稱,並且不要在首尾添加空白符。
簡單來說,就是不用賦值。
編寫HTML 程式碼時,盡量避免多餘的父元素。很多時候,這需要迭代和重構來實現。請看下面的案例:
<!-- Not so great --> <span class="avatar"> <img src="..."> </span> <!-- Better --> <img class="avatar" src="...">
透過JavaScript 產生的標籤讓內容變得不易找到、編輯,並且降低效能。能避免時盡量避免。
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;。
/* Bad CSS */ .selector, .selector-secondary, .selector[type=text] { padding:15px; margin:0px 0px 15px; background-color:rgba(0, 0, 0, 0.5); box-shadow:0px 1px 2px #CCC,inset 0 1px 0 #FFFFFF } /* Good CSS */ .selector, .selector-secondary, .selector[type="text"] { padding: 15px; margin-bottom: 15px; background-color: rgba(0,0,0,.5); box-shadow: 0 1px 2px #ccc, inset 0 1px 0 #fff; }
相關的屬性聲明應歸為一組,並依照下方的順序排列:
Positioning
Box model
Typographic
Visual
由於定位(positioning)可以從正常的文件流中移除元素,並且還能覆蓋盒模型(box model)相關的樣式,因此排在首位。盒模型排在第二位,因為它決定了組件的尺寸和位置。
其他屬性只是影響組件的內部(inside)或不影響前兩組屬性,因此排在後面。
.declaration-order { /* Positioning */ position: absolute; top: 0; right: 0; bottom: 0; left: 0; z-index: 100; /* Box-model */ display: block; float: right; width: 100px; height: 100px; /* Typography */ font: normal 13px "Helvetica Neue", sans-serif; line-height: 1.5; color: #333; text-align: center; /* Visual */ background-color: #f5f5f5; border: 1px solid #e5e5e5; border-radius: 3px; /* Misc */ opacity: 1; }
與標籤相比,@import 指令慢很多,不光增加了額外的請求次數,還會導致不可預料的問題。替代辦法有以下幾種:
透過Sass 或Less 類似的CSS 預處理器將多個CSS 檔案編譯為一個檔案透過Rails、Jekyll 或其他系統中提供過CSS 檔案合併功能
<!-- Use link elements --> <link rel="stylesheet" href="core.css"> <!-- Avoid @imports --> <style> @import url("more.css"); </style>
將媒體查詢放在盡可能相關規則的附近。不要將他們打包放在一個單一樣式文件中或放在文件底部。如果你把他們分開了,將來只會被大家遺忘。下面給出一個典型的實例。
.element { ... } .element-avatar { ... } .element-selected { ... } @media (min-width: 480px) { .element { ...} .element-avatar { ... } .element-selected { ... } }
對於只包含一條聲明的樣式,為了易讀性和方便快速編輯,建議將語句放在同一行。對於帶有多條聲明的樣式,還是應將聲明分為多行。
這樣做的關鍵因素是為了錯誤偵測– 例如,CSS 校驗器指出183 行有語法錯誤。如果是單行單條聲明,你就不會忽略這個錯誤;如果是單行多條聲明的話,你就要仔細分析避免漏掉錯誤了。
/* Single declarations on one line */ .span1 { width: 60px; } .span2 { width: 140px; } .span3 { width: 220px; } /* Multiple declarations, one per line */ .sprite { display: inline-block; width: 16px; height: 15px; background-image: url(../img/sprite.png); } .icon { background-position: 0 0; } .icon-home { background-position: 0 -20px; } .icon-account { background-position: 0 -40px; }
在需要顯示地設定所有值的情況下,應盡量限制使用簡寫形式的屬性聲明。常見的濫用簡寫屬性聲明的情況如下:
padding
margin
font
background
border
border-radius
大部分情況下,我們不需要為簡寫形式的屬性宣告指定所有值。例如,HTML 的heading 元素只需要設定上、下邊距(margin)的值,因此,在必要的時候,只需覆寫這兩個值即可。過度使用簡寫形式的屬性聲明會導致程式碼混亂,並且會對屬性值帶來不必要的覆蓋從而引起意外的副作用。
/* Bad example */ .element { margin: 0 0 10px; background: red; background: url("image.jpg"); border-radius: 3px 3px 0 0; } /* Good example */ .element { margin-bottom: 10px; background-color: red; background-image: url("image.jpg"); border-top-left-radius: 3px; border-top-right-radius: 3px; }
避免不必要的嵌套。這是因為雖然你可以使用嵌套,但是並不意味著應該使用嵌套。只有在必須將樣式限制在父元素內(也就是後代選擇器),並且存在多個需要嵌套的元素時才使用巢狀。
// Without nesting .table > thead > tr > th { … } .table > thead > tr > td { … } // With nesting .table > thead > tr { > th { … } > td { … } }
為了提高可讀性,在圓括號中的數學計算表達式的數值、變數和運算子之間均添加一個空格。
// Bad example .element { margin: 10px 0 @variable*2 10px; } // Good example .element { margin: 10px 0 (@variable * 2) 10px; }
程式碼是由人編寫並維護的。請確保你的程式碼能夠自我描述、註解良好且易於他人理解。好的程式碼註解能夠傳達上下文關係和程式碼目的。不要簡單重申組件或class 名稱。
對於較長的註釋,務必書寫完整的句子;對於一般性註解,可以書寫簡潔的短語。
/* Bad example */ /* Modal header */ .modal-header { … } /* Good example */ /* Wrapping element for .modal-title and .modal-close */ .modal-header { … }
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 檔案中。
/* Bad example */ .t { ... } .red { ... } .header { ... } /* Good example */ .tweet { ... } .important { ... } .tweet-header { ... }
對於通用元素使用class ,這樣利於渲染效能的最佳化。
對於經常出現的元件,請避免使用屬性選擇器(例如,[class^=”…”])。瀏覽器的效能會受到這些因素的影響。
選擇器要盡量短,並且盡量限制組成選擇器的元素個數,建議不要超過3 。
只有在必要的時候才將class 限制在最近的父元素內(也就是後代選擇器)(例如,不使用帶有前綴的class 時– 前綴類似於命名空間)。
/* Bad example */ span { ... } .page-container #stream .stream-item .tweet .tweet-header .username { ... } .avatar { ... } /* Good example */ .avatar { ... } .tweet-header .username { ... } .tweet .avatar { ... }
將你的編輯器按照下面的配置進行設置,以避免常見的程式碼不一致和差異:
用兩個空格代替製表符(soft-tab 即用空格代表tab 符)。 儲存檔案時,刪除尾部的空白符。 設定檔編碼為UTF-8。 在文件結尾添加一個空白行。
參考文件並將這些設定資訊新增至專案的.editorconfig檔。例如:Bootstrap 中的.editorconfig 實例。更多資訊請參考about EditorConfig。