Bootstrap HTML編碼規範

語法

  • 用兩個空格來代替製表符(tab) -- 這是唯一能保證在所有環境下獲得一致展現的方法。
  • 嵌套元素應當縮進一次(即兩個空格)。
  • 對於屬性的定義,確保全部使用雙引號,絕不要使用單引號。
  • 不要在自閉合(self-closing)元素的尾部添加斜線 -- HTML5 規範中明確說明這是可選的。
  • 不要省略可選的結束標簽(closing tag)(例如,</li></body>)。

實例:

<!DOCTYPE html>
<html>
  <head>
    <title>Page title</title>
  </head>
  <body>
    <img decoding="async" src="images/company-logo.png" alt="Company">
    <h1 class="hello-world">Hello, world!</h1>
  </body>
</html>

HTML5 doctype

為每個 HTML 頁麵的第一行添加標準模式(standard mode)的聲明,這樣能夠確保在每個瀏覽器中擁有一致的展現。

實例:

<!DOCTYPE html>
<html>
  <head>
  </head>
</html>

語言屬性

根據 HTML5 規範:

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

這裏列出了語言代碼表

<html lang="zh">
  <!-- ... -->
</html>

IE 兼容模式

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

<meta http-equiv="X-UA-Compatible" content="IE=Edge">

字符編碼

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

<head>
  <meta charset="UTF-8">
</head>

引入 CSS 和 JavaScript 文件

根據 HTML5 規範,在引入 CSS 和 JavaScript 文件時一般不需要指定 type 屬性,因為 text/csstext/javascript 分別是它們的默認值。

HTML5 spec links

<!-- 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
  • title, alt
  • aria-*, role

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

<a class="..." id="..." data-modal="toggle" href="#">
  Example link
</a>

<input class="form-control" type="text">

<img decoding="async" src="..." alt="...">

布爾(boolean)型屬性

布爾型屬性可以在聲明時不賦值。XHTML 規範要求為其賦值,但是 HTML5 規範不需要。

更多信息請參考 WhatWG section on boolean attributes

元素的布爾型屬性如果有值,就是 true,如果沒有值,就是 false。

如果一定要為其賦值的話,請參考 WhatWG 規範:

如果屬性存在,其值必須是空字符串或 [...] 屬性的規範名稱,並且不要在首尾添加空白符。

簡單來說,就是不用賦值。

<input type="text" disabled>

<input type="checkbox" value="1" checked>

<select>
  <option value="1" selected>1</option>
</select>

減少標簽的數量

編寫 HTML 代碼時,盡量避免多餘的父元素。很多時候,這需要迭代和重構來實現。請看下麵的案例:

<!-- Not so great -->
<span class="avatar">
  <img decoding="async" src="...">
</span>

<!-- Better -->
<img decoding="async" class="avatar" src="...">

JavaScript 生成的標簽

通過 JavaScript 生成的標簽讓內容變得不易查找、編輯,並且降低性能。能避免時盡量避免。