H5 HTML程式碼編寫規範及注意要點
HTML及H5程式碼編寫規範及注意要點
語法:
- 用兩個空格來代替製表符(tab) -- 這是唯一能保證在所有環境下獲得一致展現的方法。
- 巢狀元素應當縮排一次(即兩個空格)。
- 對於屬性的定義,確保全部使用雙引號,絕不要使用單引號。
- 不要在自閉合(self-closing)元素的尾部新增斜線 -- HTML5 規範中明確說明這是可選的。
- 不要省略可選的結束標籤(closing tag)(例如,
</li>
或</body>
)。
例項:
<!DOCTYPE html><html><head><title>Page title</title></head><body><imgsrc="images/company-logo.png"alt="Company"><h1class="hello-world">Hello, world!</h1></body></html>
HTML5 doctype
為每個 HTML 頁面的第一行新增標準模式(standard mode)的宣告,這樣能夠確保在每個瀏覽器中擁有一致的展現。
例項:
<!DOCTYPE html><html><head></head></html>
語言屬性
根據 HTML5 規範:
強烈建議為 html 根元素指定 lang 屬性,從而為文件設定正確的語言。這將有助於語音合成工具確定其所應該採用的發音,有助於翻譯工具確定其翻譯時所應遵守的規則等等。
更多關於 lang
屬性的知識可以從 此規範 中瞭解。
這裡列出了語言程式碼表。
<htmllang="zh-CN"><!-- ... --></html>
IE 相容模式
IE 支援通過特定的 <meta>
標籤來確定繪製當前頁面所應該採用的 IE 版本。除非有強烈的特殊需求,否則最好是設定為 edge mode,從而通知 IE 採用其所支援的最新的模式。
<metahttp-equiv="X-UA-Compatible"content="IE=Edge">
字元編碼
通過明確宣告字元編碼,能夠確保瀏覽器快速並容易的判斷頁面內容的渲染方式。這樣做的好處是,可以避免在 HTML 中使用字元實體標記(character entity),從而全部與文件編碼一致(一般採用 UTF-8 編碼)。
<head><metacharset="UTF-8"></head>
引入 CSS 和 JavaScript 檔案
根據 HTML5 規範,在引入 CSS 和 JavaScript 檔案時一般不需要指定 type
屬性,因為 text/css
和text/javascript
分別是它們的預設值。
HTML5 spec links
<!-- External CSS --><linkrel="stylesheet"href="code-guide.css"><!-- In-document CSS --><style>/* ... */</style><!-- JavaScript --><scriptsrc="code-guide.js"></script>
實用為王
儘量遵循 HTML 標準和語義,但是不要以犧牲實用性為代價。任何時候都要儘量使用最少的標籤並保持最小的複雜度。
屬性順序
HTML 屬性應當按照以下給出的順序依次排列,確保程式碼的易讀性。
class
id
,name
data-*
src
,for
,type
,href
title
,alt
aria-*
,role
class 用於標識高度可複用元件,因此應該排在首位。id 用於標識具體元件,應當謹慎使用(例如,頁面內的書籤),因此排在第二位。
<aclass="..."id="..."data-modal="toggle"href="#"> Example link </a><inputclass="form-control"type="text"><imgsrc="..."alt="...">
布林(boolean)型屬性
布林型屬性可以在宣告時不賦值。XHTML 規範要求為其賦值,但是 HTML5 規範不需要。
元素的布林型屬性如果有值,就是 true,如果沒有值,就是 false。
如果一定要為其賦值的話,請參考 WhatWG 規範:
如果屬性存在,其值必須是空字串或 [...] 屬性的規範名稱,並且不要在首尾新增空白符。
簡單來說,就是不用賦值。
<inputtype="text"disabled><inputtype="checkbox"value="1"checked><select><optionvalue="1"selected>1</option></select>
減少標籤的數量
編寫 HTML 程式碼時,儘量避免多餘的父元素。很多時候,這需要迭代和重構來實現。請看下面的案例:
<!-- Not so great --><spanclass="avatar"><imgsrc="..."></span><!-- Better --><imgclass="avatar"src="...">
JavaScript 生成的標籤
通過 JavaScript 生成的標籤讓內容變得不易查詢、編輯,並且降低效能。能避免時儘量避免。