Latest web development tutorials

Bootstrap HTML編碼規範

語法

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

實例： 

<!DOCTYPE html>
<html>
  <head>
    <title>Page title</title>
  </head>
  <body>
    <img 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 屬性，從而為文檔設置正確的語言。 這將有助於語音合成工具確定其所應該採用的發音，有助於翻譯工具確定其翻譯時所應遵守的規則等等。

更多關於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/css和text/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 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 生成的標籤讓內容變得不易查找、編輯，並且降低性能。 能避免時盡量避免。