一二二、百度編碼規範--HTML

HTML編碼規範

• • 1 前言
  • 2 代碼風格
  • • 2.1 縮進與換行
    • • [強制] 使用 `4` 個空格做為一個縮進層級，不允許使用 `2` 個空格 或 `tab` 字元。
      • [建議] 每行不得超過 `120` 個字元。
    • 2.2 命名
    • • [強制] `class` 必須單詞全字母小寫，單詞間以 `-` 分隔。
      • [強制] `class` 必須代表相應子產品或部件的内容或功能，不得以樣式資訊進行命名。
      • [強制] 元素 `id` 必須保證頁面唯一。
      • [建議] `id` 建議單詞全字母小寫，單詞間以 `-` 分隔。同項目必須保持風格一緻。
      • [建議] `id`、`class` 命名，在避免沖突并描述清楚的前提下盡可能短。
      • [強制] 禁止為了 `hook 腳本`，建立無樣式資訊的 `class`。
      • [強制] 同一頁面，應避免使用相同的 `name` 與 `id`。
    • 2.3 标簽
    • • [強制] 标簽名必須使用小寫字母。
      • [強制] 對于無需自閉合的标簽，不允許自閉合。
      • [強制] 對 `HTML5` 中規定允許省略的閉合标簽，不允許省略閉合标簽。
      • [強制] 标簽使用必須符合标簽嵌套規則。
      • [建議] HTML 标簽的使用應該遵循标簽的語義。
      • [建議] 在 CSS 可以實作相同需求的情況下不得使用表格進行布局。
      • [建議] 标簽的使用應盡量簡潔，減少不必要的标簽。
    • 2.4 屬性
    • • [強制] 屬性名必須使用小寫字母。
      • [強制] 屬性值必須用雙引号包圍。
      • [強制] 屬性名與屬性值中間不得存在空格。
      • [建議] 布爾類型的屬性，建議不添加屬性值。
      • [建議] 自定義屬性建議以 `xxx-` 為字首，推薦使用 `data-`。
  • 3 通用
  • • 3.1 DOCTYPE
    • • [強制] 使用 `HTML5` 的 `doctype` 來啟用标準模式，建議使用大寫的 `DOCTYPE`。
      • [建議] 啟用 IE Edge 模式。
      • [建議] 在 `html` 标簽上設定正确的 `lang` 屬性。
    • 3.2 編碼
    • • [強制] 頁面必須使用精簡形式，明确指定字元編碼。指定字元編碼的 `meta` 必須是 `head` 的第一個直接子元素。
      • [建議] `HTML` 檔案使用無 `BOM` 的 `UTF-8` 編碼。
    • 3.3 CSS 和 JavaScript 引入
    • • [強制] 引入 `CSS` 時必須指明 `rel="stylesheet"`。
      • [建議] 引入 `CSS` 和 `JavaScript` 時無須指明 `type` 屬性。
      • [建議] 展現定義放置于外部 `CSS` 中，行為定義放置于外部 `JavaScript` 中。
      • [建議] 在 `head` 中引入頁面需要的所有 `CSS` 資源。
      • [建議] `JavaScript` 應當放在頁面末尾，或采用異步加載。
      • [建議] 移動環境或隻針對現代浏覽器設計的 Web 應用，如果引用外部資源的 `URL` 協定部分與頁面相同，建議省略協定字首。
  • 4 head
  • • 4.1 title
    • • [強制] 頁面必須包含 `title` 标簽聲明标題。
      • [強制] `title` 必須作為 `head` 的直接子元素，并緊随 `charset` 聲明之後。
    • 4.2 favicon
    • • [強制] 保證 `favicon` 可通路。
    • 4.3 viewport
    • • [建議] 若頁面欲對移動裝置友好，需指定頁面的 `viewport`。
  • 5 圖檔
  • • • [強制] 禁止 `img` 的 `src` 取值為空。延遲加載的圖檔也要增加預設的 `src`。
      • [建議] 避免為 `img` 添加不必要的 `title` 屬性。
      • [建議] 為重要圖檔添加 `alt` 屬性。
      • [建議] 添加 `width` 和 `height` 屬性，以避免頁面抖動。
      • [建議] 有下載下傳需求的圖檔采用 `img` 标簽實作，無下載下傳需求的圖檔采用 CSS 背景圖實作。
  • 6 表單
  • • 6.1 控件标題
    • • [強制] 有文本标題的控件必須使用 `label` 标簽将其與其标題相關聯。
    • 6.2 按鈕
    • • [強制] 使用 `button` 元素時必須指明 `type` 屬性值。
      • [建議] 盡量不要使用按鈕類元素的 `name` 屬性。
    • 6.3 可通路性 (A11Y)
    • • [建議] 負責主要功能的按鈕在 DOM 中的順序應靠前。
      • [建議] 當使用 JavaScript 進行表單送出時，如果條件允許，應使原生送出功能正常工作。
      • [建議] 在針對移動裝置開發的頁面時，根據内容類型指定輸入框的 `type` 屬性。
  • 7 多媒體
  • • • [建議] 當在現代浏覽器中使用 `audio` 以及 `video` 标簽來播放音頻、視訊時，應當注意格式。
      • [建議] 在支援 `HTML5` 的浏覽器中優先使用 `audio` 和 `video` 标簽來定義音視訊元素。
      • [建議] 使用退化到插件的方式來對多浏覽器進行支援。
      • [建議] 隻在必要的時候開啟音視訊的自動播放。
      • [建議] 在 `object` 标簽内部提供訓示浏覽器不支援該标簽的說明。
  • 8 模闆中的 HTML
  • • • [建議] 模闆代碼的縮進優先保證 HTML 代碼的縮進規則。
      • [建議] 模闆代碼應以保證 HTML 單個标簽文法的正确性為基本原則。
      • [建議] 在循環處理模闆資料構造表格時，若要求每行輸出固定的個數，建議先将資料分組，之後再循環輸出。
    • [建議] 新視窗/标簽頁打開的連結需要按業務需要添加安全相關的 `rel` 屬性值 `noopener`。

1 前言

HTML 作為描述網頁結構的超文本标記語言，在百度一直有着廣泛的應用。本文檔的目标是使 HTML 代碼風格保持一緻，容易被了解和被維護。

任何問題或建議，歡迎跟我們讨論: [email protected]

2 代碼風格

2.1 縮進與換行

[強制] 使用

4

個空格做為一個縮進層級，不允許使用

2

個空格 或

tab

字元。

解釋：

對于非 HTML 标簽之間的縮進，比如 script 或 style 标簽内容縮進，與 script 或 style 标簽的縮進同級。

示例：

<style>
/* 樣式内容的第一級縮進與所屬的 style 标簽對齊 */
ul {
    padding: 0;
}
</style>
<ul>
    <li>first</li>
    <li>second</li>
</ul>
<script>
// 腳本代碼的第一級縮進與所屬的 script 标簽對齊
require(['app'], function (app) {
    app.init();
});
</script>
           

[建議] 每行不得超過

120

個字元。

解釋：

過長的代碼不容易閱讀與維護。但是考慮到 HTML 的特殊性，不做硬性要求。

2.2 命名

[強制]

class

必須單詞全字母小寫，單詞間以

-

分隔。

[強制]

class

必須代表相應子產品或部件的内容或功能，不得以樣式資訊進行命名。

示例：

<!-- good -->
<div class="sidebar"></div>

<!-- bad -->
<div class="left"></div>
           

[強制] 元素

id

必須保證頁面唯一。

解釋：

同一個頁面中，不同的元素包含相同的

id

，不符合

id

的屬性含義。并且使用

document.getElementById

時可能導緻難以追查的問題。

[建議]

id

建議單詞全字母小寫，單詞間以

-

分隔。同項目必須保持風格一緻。

[建議]

id

、

class

命名，在避免沖突并描述清楚的前提下盡可能短。

示例：

<!-- good -->
<div id="nav"></div>
<!-- bad -->
<div id="navigation"></div>

<!-- good -->
<p class="comment"></p>
<!-- bad -->
<p class="com"></p>

<!-- good -->
<span class="author"></span>
<!-- bad -->
<span class="red"></span>
           

[強制] 禁止為了

hook 腳本

，建立無樣式資訊的

class

。

解釋：

不允許

class

隻用于讓 JavaScript 選擇某些元素，

class

應該具有明确的語義和樣式。否則容易導緻 CSS class 泛濫。

使用

id

、屬性選擇作為 hook 是更好的方式。

[強制] 同一頁面，應避免使用相同的

name

與

id

。

解釋：

IE 浏覽器會混淆元素的

id

和

name

屬性，

document.getElementById

可能獲得不期望的元素。是以在對元素的

id

與

name

屬性的命名需要非常小心。

一個比較好的實踐是，為

id

和

name

使用不同的命名法。

示例：

<input name="foo">
<div id="foo"></div>
<script>
// IE6 将顯示 INPUT
alert(document.getElementById('foo').tagName);
</script>
           

2.3 标簽

[強制] 标簽名必須使用小寫字母。

示例：

<!-- good -->
<p>Hello StyleGuide!</p>

<!-- bad -->
<P>Hello StyleGuide!</P>
           

[強制] 對于無需自閉合的标簽，不允許自閉合。

解釋：

常見無需自閉合标簽有

input

、

br

、

img

、

hr

等。

示例：

<!-- good -->
<input type="text" name="title">

<!-- bad -->
<input type="text" name="title" />
           

[強制] 對

HTML5

中規定允許省略的閉合标簽，不允許省略閉合标簽。

解釋：

對代碼體積要求非常嚴苛的場景，可以例外。比如：第三方頁面使用的投放系統。

示例：

<!-- good -->
<ul>
    <li>first</li>
    <li>second</li>
</ul>

<!-- bad -->
<ul>
    <li>first
    <li>second
</ul>
           

[強制] 标簽使用必須符合标簽嵌套規則。

解釋：

比如

div

不得置于

p

中，

tbody

必須置于

table

中。

詳細的标簽嵌套規則參見HTML DTD中的

Elements

定義部分。

[建議] HTML 标簽的使用應該遵循标簽的語義。

解釋：

下面是常見标簽語義

• p - 段落
• h1,h2,h3,h4,h5,h6 - 層級标題
• strong,em - 強調
• ins - 插入
• del - 删除
• abbr - 縮寫
• code - 代碼辨別
• cite - 引述來源作品的标題
• q - 引用
• blockquote - 一段或長篇引用
• ul - 無序清單
• ol - 有序清單
• dl,dt,dd - 定義清單

示例：

<!-- good -->
<p>Esprima serves as an important <strong>building block</strong> for some JavaScript language tools.</p>

<!-- bad -->
<div>Esprima serves as an important <span class="strong">building block</span> for some JavaScript language tools.</div>
           

[建議] 在 CSS 可以實作相同需求的情況下不得使用表格進行布局。

解釋：

在相容性允許的情況下應盡量保持語義正确性。對網格對齊和拉伸性有嚴格要求的場景允許例外，如多列複雜表單。

[建議] 标簽的使用應盡量簡潔，減少不必要的标簽。

示例：

<!-- good -->
<img class="avatar" src="image.png">

<!-- bad -->
<span class="avatar">
    <img src="image.png">
</span>
           

2.4 屬性

[強制] 屬性名必須使用小寫字母。

示例：

<!-- good -->
<table cellspacing="0">...</table>

<!-- bad -->
<table cellSpacing="0">...</table>
           

[強制] 屬性值必須用雙引号包圍。

解釋：

不允許使用單引号，不允許不使用引号。

示例：

<!-- good -->
<script src="esl.js"></script>

<!-- bad -->
<script src='esl.js'></script>
<script src=esl.js></script>
           

[強制] 屬性名與屬性值中間不得存在空格。

解釋：

按 HTML 規範

=

兩邊可以存在空格，但為了保持一緻不允許添加空格。

示例：

<!-- good -->
<input type="text">

<!-- bad -->
<input type = "text">
           

[建議] 布爾類型的屬性，建議不添加屬性值。

示例：

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

[建議] 自定義屬性建議以

xxx-

為字首，推薦使用

data-

。

解釋：

使用字首有助于區分自定義屬性和标準定義的屬性。

示例：

3 通用

3.1 DOCTYPE

[強制] 使用

HTML5

的

doctype

來啟用标準模式，建議使用大寫的

DOCTYPE

。

示例：

[建議] 啟用 IE Edge 模式。

示例：

[建議] 在

html

标簽上設定正确的

lang

屬性。

解釋：

有助于提高頁面的可通路性，如：讓語音合成工具确定其所應該采用的發音，令翻譯工具确定其翻譯語言等。

示例：

3.2 編碼

[強制] 頁面必須使用精簡形式，明确指定字元編碼。指定字元編碼的

meta

必須是

head

的第一個直接子元素。

解釋：

見 HTML5 Charset能用嗎 一文。

示例：

<html>
    <head>
        <meta charset="UTF-8">
        ......
    </head>
    <body>
        ......
    </body>
</html>
           

[建議]

HTML

檔案使用無

BOM

的

UTF-8

編碼。

解釋：

UTF-8

編碼具有更廣泛的适應性。

BOM

在使用程式或工具處理檔案時可能造成不必要的幹擾。

3.3 CSS 和 JavaScript 引入

[強制] 引入

CSS

時必須指明

rel="stylesheet"

。

示例：

[建議] 引入

CSS

和

JavaScript

時無須指明

type

屬性。

解釋：

text/css

和

text/javascript

是

type

的預設值。

[建議] 展現定義放置于外部

CSS

中，行為定義放置于外部

JavaScript

中。

解釋：

結構-樣式-行為的代碼分離，對于提高代碼的可閱讀性和維護性都有好處。

[建議] 在

head

中引入頁面需要的所有

CSS

資源。

解釋：

在頁面渲染的過程中，新的CSS可能導緻元素的樣式重新計算和繪制，頁面閃爍。

[建議]

JavaScript

應當放在頁面末尾，或采用異步加載。

解釋：

将

script

放在頁面中間将阻斷頁面的渲染。出于性能方面的考慮，如非必要，請遵守此條建議。

示例：

<body>
    <!-- a lot of elements -->
    <script src="init-behavior.js"></script>
</body>
           

[建議] 移動環境或隻針對現代浏覽器設計的 Web 應用，如果引用外部資源的

URL

協定部分與頁面相同，建議省略協定字首。

解釋：

使用

protocol-relative URL

引入 CSS，在

IE7/8

下，會發兩次請求。是否使用

protocol-relative URL

應充分考慮頁面針對的環境。

示例：

4 head

4.1 title

[強制] 頁面必須包含

title

标簽聲明标題。

[強制]

title

必須作為

head

的直接子元素，并緊随

charset

聲明之後。

解釋：

title

中如果包含 ASCII 之外的字元，浏覽器需要知道字元編碼類型才能進行解碼，否則可能導緻亂碼。

示例：

<head>
    <meta charset="UTF-8">
    <title>頁面标題</title>
</head>
           

4.2 favicon

[強制] 保證

favicon

可通路。

解釋：

在未指定 favicon 時，大多數浏覽器會請求 Web Server 根目錄下的

favicon.ico

。為了保證 favicon 可通路，避免 404，必須遵循以下兩種方法之一：

1. 在 Web Server 根目錄放置

   favicon.ico

   檔案。
2. 使用

   link

   指定 favicon。

示例：

4.3 viewport

[建議] 若頁面欲對移動裝置友好，需指定頁面的

viewport

。

解釋：

viewport meta tag 可以設定可視區域的寬度和初始縮放大小，避免在移動裝置上出現頁面展示不正常。

比如，在頁面寬度小于

980px

時，若需 iOS 裝置友好，應當設定 viewport 的

width

值來适應你的頁面寬度。同時因為不同移動裝置分辨率不同，在設定時，應當使用

device-width

和

device-height

變量。

另外，為了使 viewport 正常工作，在頁面内容樣式布局設計上也要做相應調整，如避免絕對定位等。關于 viewport 的更多介紹，可以參見 Safari Web Content Guide的介紹

5 圖檔

[強制] 禁止

img

的

src

取值為空。延遲加載的圖檔也要增加預設的

src

。

解釋：

src

取值為空，會導緻部分浏覽器重新加載一次目前頁面，參考：https://developer.yahoo.com/performance/rules.html#emptysrc

[建議] 避免為

img

添加不必要的

title

屬性。

解釋：

多餘的

title

影響看圖體驗，并且增加了頁面尺寸。

[建議] 為重要圖檔添加

alt

屬性。

解釋：

可以提高圖檔加載失敗時的使用者體驗。

[建議] 添加

width

和

height

屬性，以避免頁面抖動。

[建議] 有下載下傳需求的圖檔采用

img

标簽實作，無下載下傳需求的圖檔采用 CSS 背景圖實作。

解釋：

1. 産品 logo、使用者頭像、使用者産生的圖檔等有潛在下載下傳需求的圖檔，以

   img

   形式實作，能友善使用者下載下傳。
2. 無下載下傳需求的圖檔，比如：icon、背景、代碼使用的圖檔等，盡可能采用 CSS 背景圖實作。

6 表單

6.1 控件标題

[強制] 有文本标題的控件必須使用

label

标簽将其與其标題相關聯。

解釋：

有兩種方式：

1. 将控件置于

   label

   内。

2. label

   的

   for

   屬性指向控件的

   id

   。

推薦使用第一種，減少不必要的

id

。如果 DOM 結構不允許直接嵌套，則應使用第二種。

示例：

<label><input type="checkbox" name="confirm" value="on"> 我已确認上述條款</label>

<label for="username">使用者名：</label> <input type="textbox" name="username" id="username">
           

6.2 按鈕

[強制] 使用

button

元素時必須指明

type

屬性值。

解釋：

button

元素的預設

type

為

submit

，如果被置于

form

元素中，點選後将導緻表單送出。為顯示區分其作用友善了解，必須給出

type

屬性。

示例：

<button type="submit">送出</button>
<button type="button">取消</button>
           

[建議] 盡量不要使用按鈕類元素的

name

屬性。

解釋：

由于浏覽器相容性問題，使用按鈕的

name

屬性會帶來許多難以發現的問題。具體情況可參考此文。

6.3 可通路性 (A11Y)

[建議] 負責主要功能的按鈕在 DOM 中的順序應靠前。

解釋：

負責主要功能的按鈕應相對靠前，以提高可通路性。如果在 CSS 中指定了

float: right

則可能導緻視覺上主按鈕在前，而 DOM 中主按鈕靠後的情況。

示例：

<!-- good -->
<style>
.buttons .button-group {
    float: right;
}
</style>

<div class="buttons">
    <div class="button-group">
        <button type="submit">送出</button>
        <button type="button">取消</button>
    </div>
</div>

<!-- bad -->
<style>
.buttons button {
    float: right;
}
</style>

<div class="buttons">
    <button type="button">取消</button>
    <button type="submit">送出</button>
</div>
           

[建議] 當使用 JavaScript 進行表單送出時，如果條件允許，應使原生送出功能正常工作。

解釋：

當浏覽器 JS 運作錯誤或關閉 JS 時，送出功能将無法工作。如果正确指定了

form

元素的

action

屬性和表單控件的

name

屬性時，送出仍可繼續進行。

示例：

<form action="/login" method="post">
    <p><input name="username" type="text" placeholder="使用者名"></p>
    <p><input name="password" type="password" placeholder="密碼"></p>
</form>
           

[建議] 在針對移動裝置開發的頁面時，根據内容類型指定輸入框的

type

屬性。

解釋：

根據内容類型指定輸入框類型，能獲得能友好的輸入體驗。

示例：

7 多媒體

[建議] 當在現代浏覽器中使用

audio

以及

video

标簽來播放音頻、視訊時，應當注意格式。

解釋：

音頻應盡可能覆寫到如下格式：

• MP3
• WAV
• Ogg

視訊應盡可能覆寫到如下格式：

• MP4
• WebM
• Ogg

[建議] 在支援

HTML5

的浏覽器中優先使用

audio

和

video

标簽來定義音視訊元素。

[建議] 使用退化到插件的方式來對多浏覽器進行支援。

示例：

<audio controls>
    <source src="audio.mp3" type="audio/mpeg">
    <source src="audio.ogg" type="audio/ogg">
    <object width="100" height="50" data="audio.mp3">
        <embed width="100" height="50" src="audio.swf">
    </object>
</audio>

<video width="100" height="50" controls>
    <source src="video.mp4" type="video/mp4">
    <source src="video.ogg" type="video/ogg">
    <object width="100" height="50" data="video.mp4">
        <embed width="100" height="50" src="video.swf">
    </object>
</video>
           

[建議] 隻在必要的時候開啟音視訊的自動播放。

[建議] 在

object

标簽内部提供訓示浏覽器不支援該标簽的說明。

示例：

8 模闆中的 HTML

[建議] 模闆代碼的縮進優先保證 HTML 代碼的縮進規則。

示例：

<!-- good -->
{if $display == true}
<div>
    <ul>
    {foreach $item_list as $item}
        <li>{$item.name}<li>
    {/foreach}
    </ul>
</div>
{/if}

<!-- bad -->
{if $display == true}
    <div>
        <ul>
    {foreach $item_list as $item}
        <li>{$item.name}<li>
    {/foreach}
        </ul>
    </div>
{/if}
           

[建議] 模闆代碼應以保證 HTML 單個标簽文法的正确性為基本原則。

示例：

<!-- good -->
<li class="{if $item.type_id == $current_type}focus{/if}">{ $item.type_name }</li>

<!-- bad -->
<li {if $item.type_id == $current_type} class="focus"{/if}>{ $item.type_name }</li>
           

[建議] 在循環處理模闆資料構造表格時，若要求每行輸出固定的個數，建議先将資料分組，之後再循環輸出。

示例：

<!-- good -->
<table>
    {foreach $item_list as $item_group}
    <tr>
        {foreach $item_group as $item}
        <td>{ $item.name }</td>
        {/foreach}
    <tr>
    {/foreach}
</table>

<!-- bad -->
<table>
<tr>
    {foreach $item_list as $item}
    <td>{ $item.name }</td>
        {if [email protected] is div by 5}
    </tr>
    <tr>
        {/if}
    {/foreach}
</tr>
</table>
           

[建議] 新視窗/标簽頁打開的連結需要按業務需要添加安全相關的

rel

屬性值

noopener

。

解釋：

新視窗/标簽頁打開的網頁可以通過

window.opener

通路原網頁的上下文，會引入安全問題。例如從搜尋結果頁打開的網頁可以通過

window.opener

将結果頁篡改為釣魚網頁，使用者傳回時将通路惡意網頁内容。詳見 4.8.6.8. Link type “noopener” - HTML 5.2。

示例：

<!-- good -->
<a href="//external.website/" target="_blank" rel="noopener">外部連結</a>

<!-- bad -->
<a href="//external.website/" target="_blank">外部連結</a>