Bootstrap HTML編碼規範


語法

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

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

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

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

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

實例:

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

#HTML55 doctype

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

實例:

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

語言屬性

依據HTML5 規格:

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

更多關於 lang 屬性的知識可以從 此規範 中了解。

這裡列出了語言程式碼表。

<html lang="zh-CN">
  <!-- ... -->
</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

  • Using link

  • Using style

  • Using script

<!-- 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 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 src=". ..">
</span>

<!-- Better -->

<img class="avatar" src="...">

JavaScript 產生的標籤

透過JavaScript 產生的標籤讓內容變得不容易找到、編輯,並且降低效能。能避免時盡量避免。 ################