編寫靈活、穩定、高質量的HTML程式碼的規範

WEBING發表於2018-04-18

一、唯一定律

無論有多少人共同參與同一專案,一定要確保每一行程式碼都像是唯一個人編寫的。

二、HTML

2.1 語法

(1)用兩個空格來代替製表符(tab) -- 這是唯一能保證在所有環境下獲得一致展現的方法。

(2)巢狀元素應當縮排一次(即兩個空格)。

(3)對於屬性的定義,確保全部使用雙引號,絕不要使用單引號。

(4)不要在自閉合(self-closing)元素的尾部新增斜線 -- HTML5 規範中明確說明這是可選的。

(5)不要省略可選的結束標籤(closing tag)(例如,</li> 或 </body>)。

2.2 Example

三、HTML5 doctype

為每個 HTML 頁面的第一行新增標準模式(standard mode)的宣告,這樣能夠確保在每個瀏覽器中擁有一致的展現。

四、語言屬性

根據 HTML5 規範:

強烈建議為 html 根元素指定 lang 屬性,從而為文件設定正確的語言。這將有助於語音合成工具確定其所應該採用的發音,有助於翻譯工具確定其翻譯時所應遵守的規則等等。

五、IE 相容模式

IE 支援通過特定的 <meta> 標籤來確定繪製當前頁面所應該採用的 IE 版本。除非有強烈的特殊需求,否則最好是設定為 edge mode,從而通知 IE 採用其所支援的最新的模式。

六、字元編碼

通過明確宣告字元編碼,能夠確保瀏覽器快速並容易的判斷頁面內容的渲染方式。這樣做的好處是,可以避免在 HTML 中使用字元實體標記(character entity),從而全部與文件編碼一致(一般採用 UTF-8 編碼)。

七、引入 CSS 和 JavaScript 檔案

根據 HTML5 規範,在引入 CSS 和 JavaScript 檔案時一般不需要指定 type 屬性,因為 text/css 和 text/javascript 分別是它們的預設值。

八、實用為王

儘量遵循 HTML 標準和語義,但是不要以犧牲實用性為代價。任何時候都要儘量使用最少的標籤並保持最小的複雜度。

九、屬性順序

9.1 從大到小

HTML 屬性應當按照以下給出的順序依次排列,確保程式碼的易讀性。

(1)class

(2)id, name

(3)data-*

(4)src, for, type, href, value

(5)title, alt

(6)role, aria-*

9.2 Example

9.3 說明

class 用於標識高度可複用元件,因此應該排在首位。id 用於標識具體元件,應當謹慎使用(例如,頁面內的書籤),因此排在第二位。

十、布林(boolean)型屬性

10.1 注意

(1)布林型屬性可以在宣告時不賦值。XHTML 規範要求為其賦值,但是 HTML5 規範不需要。

(2)元素的布林型屬性如果有值,就是 true,如果沒有值,就是 false。

(3)如果屬性存在,其值必須是空字串或 [...] 屬性的規範名稱,並且不要在首尾新增空白符。
簡單來說,就是不用賦值。

10.2 Example

十一、減少標籤的數量

編寫 HTML 程式碼時,儘量避免多餘的父元素。很多時候,這需要迭代和重構來實現。

十二、減少 JavaScript 生成的標籤

通過 JavaScript 生成的標籤讓內容變得不易查詢、編輯,並且降低效能。能避免時儘量避免。

相關文章