不管有多少人共同參與同一項目,一定要確保每一行代碼都像是同一個人編寫的。
因此,編寫靈活、穩定、高質量的 HTML 和 CSS 代碼,是每一個技術人員的基本操守。
HTML
************************************************************************
1、語法
用兩個空格來代替製表符(tab) -- 這是唯一能保證在所有環境下獲得一致展現的方法。
嵌套元素應當縮進一次(即兩個空格)。
對於屬性的定義,確保全部使用雙引號,絕不要使用單引號。
不要在自閉合(self-closing)元素的尾部添加斜線 -- HTML5 規範中明確說明這是可選的。
不要省略可選的結束標籤(closing tag)(例如,
</li>
或</body>
)。
<!DOCTYPE html><html> <head> <title>Page title</title> </head> <body> <img src="p_w_picpaths/company-logo.png" alt="Company"> <h1 class="hello-world">Hello, world!</h1> </body></html>
*********
2、HTML5 doctype
爲每個 HTML 頁面的第一行添加標準模式(standard mode)的聲明,這樣能夠確保在每個瀏覽器中擁有一致的展現。
<!DOCTYPE html><html> <head> </head></html>
*********
3、語言屬性
根據 HTML5 規範:
強烈建議爲 html 根元素指定 lang 屬性,從而爲文檔設置正確的語言。這將有助於語音合成工具確定其所應該採用的發音,有助於翻譯工具確定其翻譯時所應遵守的規則等等。
<html lang="zh-CN"> <!-- ... --> </html>
*********
4、IE 兼容模式
IE 支持通過特定的 <meta>
標籤來確定繪製當前頁面所應該採用的 IE 版本。除非有強烈的特殊需求,否則最好是設置爲 edge mode,從而通知 IE 採用其所支持的最新的模式。
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
*********
5、字符編碼
通過明確聲明字符編碼,能夠確保瀏覽器快速並容易的判斷頁面內容的渲染方式。這樣做的好處是,可以避免在 HTML 中使用字符實體標記(character entity),從而全部與文檔編碼一致(一般採用 UTF-8 編碼)。
<head> <meta charset="UTF-8"> </head>
*********
6、引入 CSS 和 JavaScript 文件
根據 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>
*********
7、實用爲王
儘量遵循 HTML 標準和語義,但是不要以犧牲實用性爲代價。任何時候都要儘量使用最少的標籤並保持最小的複雜度。
*********
8、屬性順序
HTML 屬性應當按照以下給出的順序依次排列,確保代碼的易讀性。
class
id
,name
data-*
src
,for
,type
,href
title
,alt
aria-*
,role
class 用於標識高度可複用組件,因此應該排在首位。id 用於標識具體組件,應當謹慎使用(例如,頁面內的書籤),因此排在第二位。
<a class="..." id="..." data-modal="toggle" href="#"> Example link </a> <input class="form-control" type="text"> <img src="..." alt="...">
*********
9、布爾(boolean)型屬性
布爾型屬性可以在聲明時不賦值。XHTML 規範要求爲其賦值,但是 HTML5 規範不需要。
元素的布爾型屬性如果有值,就是 true,如果沒有值,就是 false。
如果一定要爲其賦值的話,請參考 WhatWG 規範:
如果屬性存在,其值必須是空字符串或 [...] 屬性的規範名稱,並且不要再收尾添加空白符。
簡單來說,就是不用賦值。
<input type="text" disabled> <input type="checkbox" value="1" checked> <select> <option value="1" selected>1</option> </select>
*********
10、減少標籤的數量
編寫 HTML 代碼時,儘量避免多餘的父元素。很多時候,這需要迭代和重構來實現。
<!-- 糟糕案例 --> <span class="avatar"> <img src="..."> </span> <!-- 最佳方案 --> <img class="avatar" src="...">
*********
11、JavaScript 生成的標籤
通過 JavaScript 生成的標籤讓內容變得不易查找、編輯,並且降低性能。能避免時儘量避免。
***************************************************************
CSS
***************************************************************
1、語法
用兩個空格來代替製表符(tab) -- 這是唯一能保證在所有環境下獲得一致展現的方法。
爲選擇器分組時,將單獨的選擇器單獨放在一行。
爲了代碼的易讀性,在每個聲明塊的左花括號前添加一個空格。
聲明塊的右花括號應當單獨成行。
每條聲明語句的
:
後應該插入一個空格。爲了獲得更準確的錯誤報告,每條聲明都應該獨佔一行。
所有聲明語句都應當以分號結尾。最後一條聲明語句後面的分號是可選的,但是,如果省略這個分號,你的代碼可能更易出錯。
對於以逗號分隔的屬性值,每個逗號後面都應該插入一個空格(例如,
box-shadow
)。不要在
rgb()
、rgba()
、hsl()
、hsla()
或rect()
值的內部的逗號後面插入空格。這樣利於從多個屬性值(既加逗號也加空格)中區分多個顏色值(只加逗號,不加空格)。對於屬性值或顏色參數,省略小於 1 的小數前面的 0 (例如,
.5
代替0.5
;-.5px
代替-0.5px
)。十六進制值應該全部小寫,例如,
#fff
。在掃描文檔時,小寫字符易於分辨,因爲他們的形式更易於區分。儘量使用簡寫形式的十六進制值,例如,用
#fff
代替#ffffff
。爲選擇器中的屬性添加雙引號,例如,
input[type="text"]
。只有在某些情況下是可選的,但是,爲了代碼的一致性,建議都加上雙引號。避免爲 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; }
*********
2、聲明順序
相關的屬性聲明應當歸爲一組,並按照下面的順序排列:
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; }
*********
3、不要使用 @import
與 <link>
標籤相比,@import
指令要慢很多,不光增加了額外的請求次數,還會導致不可預料的問題。替×××法有以下幾種:
使用多個
<link>
元素通過 Sass 或 Less 類似的 CSS 預處理器將多個 CSS 文件編譯爲一個文件
通過 Rails、Jekyll 或其他系統中提供過 CSS 文件合併功能
<!-- Use link elements --> <link rel="stylesheet" href="core.css"> <!-- Avoid @imports --> <style> @import url("more.css"); </style>
*********
4、媒體查詢(Media query)的位置
將媒體查詢放在儘可能相關規則的附近。不要將他們打包放在一個單一樣式文件中或者放在文檔底部。如果你把他們分開了,將來只會被大家遺忘。下面給出一個典型的實例。
.element { ... } .element-avatar { ... } .element-selected { ... } @media (min-width: 480px) { .element { ...} .element-avatar { ... } .element-selected { ... } }
*********
5、帶前綴的屬性
當使用特定廠商的帶有前綴的屬性時,通過縮進的方式,讓每個屬性的值在垂直方向對齊,這樣便於多行編輯。
/* Prefixed properties */ .selector { -webkit-box-shadow: 0 1px 2px rgba(0,0,0,.15); box-shadow: 0 1px 2px rgba(0,0,0,.15); }
*********
6、單行規則聲明
對於只包含一條聲明的樣式,爲了易讀性和便於快速編輯,建議將語句放在同一行。對於帶有多條聲明的樣式,還是應當將聲明分爲多行。
這樣做的關鍵因素是爲了錯誤檢測 -- 例如,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-p_w_picpath: url(../img/sprite.png); } .icon { background-position: 0 0; } .icon-home { background-position: 0 -20px; } .icon-account { background-position: 0 -40px; }
*********
7、簡寫形式的屬性聲明
在需要顯示地設置所有值的情況下,應當儘量限制使用簡寫形式的屬性聲明。常見的濫用簡寫屬性聲明的情況如下:
padding
margin
font
background
border
border-radius
大部分情況下,我們不需要爲簡寫形式的屬性聲明指定所有值。例如,HTML 的 heading 元素只需要設置上、下邊距(margin)的值,因此,在必要的時候,只需覆蓋這兩個值就可以。過度使用簡寫形式的屬性聲明會導致代碼混亂,並且會對屬性值帶來不必要的覆蓋從而引起意外的副作用。這個問題我自身也經常犯,大家只能在實踐中不斷強化意識了。
/* Bad example */ .element { margin: 0 0 10px; background: red; background: url("p_w_picpath.jpg"); border-radius: 3px 3px 0 0; } /* Good example */ .element { margin-bottom: 10px; background-color: red; background-p_w_picpath: url("p_w_picpath.jpg"); border-top-left-radius: 3px; border-top-right-radius: 3px; }
*********
8、Less 和 Sass 中的嵌套
避免非必要的嵌套。這是因爲雖然你可以使用嵌套,但是並不意味着應該使用嵌套。只有在必須將樣式限制在父元素內(也就是後代選擇器),並且存在多個需要嵌套的元素時才使用嵌套。
// Without nesting .table > thead > tr > th { … } .table > thead > tr > td { … } // With nesting .table > thead > tr { > th { … } > td { … } }
*********
9、註釋
代碼是由人編寫並維護的。請確保你的代碼能夠自描述、註釋良好並且易於他人理解。好的代碼註釋能夠傳達上下文關係和代碼目的。不要簡單地重申組件或 class 名稱。
對於較長的註釋,務必書寫完整的句子;對於一般性註解,可以書寫簡潔的短語。
/* Bad example */ /* Modal header */ .modal-header { ... } /* Good example */ /* Wrapping element for .modal-title and .modal-close */ .modal-header { ... }
*********
10、class 命名
class 名稱中只能出現小寫字符和破折號(dashe)(不是下劃線,也不是駝峯命名法)。破折號應當用於相關 class 的命名(類似於命名空間)(例如,
.btn
和.btn-danger
)。避免過度任意的簡寫。
.btn
代表 button,但是.s
不能表達任何意思。class 名稱應當儘可能短,並且意義明確。
使用有意義的名稱。使用有組織的或目的明確的名稱,不要使用表現形式(presentational)的名稱。
基於最近的父 class 或基本(base) class 作爲新 class 的前綴。
使用
.js-*
class 來標識行爲(與樣式相對),並且不要將這些 class 包含到 CSS 文件中。
在爲 Sass 和 Less 變量命名是也可以參考上面列出的各項規範。
/* Bad example */ .t { ... } .red { ... } .header { ... } /* Good example */ .tweet { ... } .important { ... } .tweet-header { ... }
*********
11、選擇器
對於通用元素使用 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 { ... }
*********
12、代碼組織
以組件爲單位組織代碼段。
制定一致的註釋規範。
使用一致的空白符將代碼分隔成塊,這樣利於掃描較大的文檔。
如果使用了多個 CSS 文件,將其按照組件而非頁面的形式分拆,因爲頁面會被重組,而組件只會被移動。
/* * Component section heading */ .element { ... } /* * Component section heading * * Sometimes you need to include optional context for the entire component. Do that up here if it's important enough. */ .element { ... } /* Contextual sub-component or modifer */ .element-heading { ... }
*********
13、編輯器配置
將你的編輯器按照下面的配置進行設置,以避免常見的代碼不一致和差異:
用兩個空格代替製表符(soft-tab 即用空格代表 tab 符)。
保存文件時,刪除尾部的空白符。
設置文件編碼爲 UTF-8。
在文件結尾添加一個空白行。
以上內容就是我們日常前端開發中的編碼規範及要求。
天道酬勤,改變自己的陋習,爭做代碼典範。
更多學習資料請自行翻閱Teny5590的51博客,
或加入到達內集團技術培訓畢業班討論QQ羣:227252731
達內學員獵頭、HR們,入羣請按照要求添加備註,否則一律不通過。