前言:
代碼規範有助於減少團隊(個人)的維護成本和方便日後的自動化改進
儘量遵循html標準和語義,但不要以犧牲實用性爲代價,任何時候都要儘量使用少的標籤並保持最小的複雜度
一、語法
- 用兩個空格來代替製表符(tab) -- 這是唯一能保證在所有環境下獲得一致展現的方法。
- 嵌套元素應當縮進一次(即兩個空格)。
- 對於屬性的定義,確保全部使用雙引號,絕不要使用單引號。
- 不要在自閉合(self-closing)元素的尾部添加斜線 -- HTML5 規範中明確說明這是可選的。
- 不要省略可選的結束標籤(closing tag)(例如,
</li>
或</body>
)。
HTML5doctype
爲每個 HTML 頁面的第一行添加標準模式(standard mode)的聲明,這樣能夠確保在每個瀏覽器中擁有一致的展現。
三、語言屬性
語言屬性:
強烈建議爲 html 根元素指定 lang 屬性,從而爲文檔設置正確的語言。這將有助於語音合成工具確定其所應該採用的發音,有助於翻譯工具確定其翻譯時所應遵守的規則等等。
四、IE 兼容模式
IE兼容模式
IE
支持通過特定的 <meta>
標籤來確定繪製當前頁面所應該採用的
IE 版本。除非有強烈的特殊需求,否則最好是設置爲 edge mode,從而通知 IE
採用其所支持的最新的模式。
<meta http-equiv = "X-UA-Compatible" content = "IE-Edge">
五、字符編碼
字符編碼
通過明確聲明字符編碼,能夠確保瀏覽器快速並容易的判斷頁面內容的渲染方式。這樣做的好處是,可以避免在HTML 中使用字符實體標記(characterentity),
從而全部與文檔編碼一致(一般採用UTF-8 編碼)。
<head>
<meta charset = "UTF-8">
</head>
六、引入css文件和JavaScript文件
引入css文件和JavaScript文件
根據 HTML5
規範,在引入 CSS
和 JavaScript
文件時一般不需要指定 type
屬性,因爲 text/css
和 text/javascript
分別是它們的默認值
七、屬性順序
屬性順序
HTML 屬性應當按照以下給出的順序依次排列,確保代碼的易讀性。
class
id
, name
data-*
src
, for
, type
, href
, value
title
, alt
role
, aria-*
class 用於標識高度可複用組件,因此應該排在首位。id 用於標識具體組件,應當謹慎使用(例如,頁面內的書籤),因此排在第二位。
<a class="" id="" data-toggle="model" href=""></a>
<input class="form-control" type="text">
<img src="" alt="">
八、布爾型屬性
布爾型屬性
布爾型屬性可以在聲明時不賦值,XHTML 規範要求爲其賦值,但是HTML5規範不需要
元素的布爾值屬性如果有值,就是true 如果沒有值,就是false
九、減少沒必要的標籤
減少標籤的數量
編寫html代碼時,儘量避免多餘的父元素,很多時候,這需要迭代和重構來實現
例如:
<!--not so great-->
<span class="avatar">
<img src="">
</span>
<!--better-->
<img class="avatar" src="">