HTML常用規范

HTML編碼規范

1 前言

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

2 代碼風格

2.1 縮進與換行

[強制] 使用 4 個空格做為一個縮進層級，不允許使用 2 個空格 或 tab 字符。

示例：

<ul>
    <li>first</li>
    <li>second</li>
</ul>

[建議] 每行不得超過 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 -->
![](image.png)

<!-- bad -->
<span class="avatar">
    ![](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>

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

示例：

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

[建議] 自定義屬性建議以 xxx- 為前綴，推薦使用 data-。

解釋：

使用前綴有助于區分自定義屬性和標準定義的屬性。

示例：

<ol data-ui-type="Select"></ol>

3 通用

3.1 DOCTYPE

[強制] 使用 HTML5 的 doctype 來啟用標準模式，建議使用大寫的 DOCTYPE。

示例：

<!DOCTYPE html>

[建議] 啟用 IE Edge 模式。

示例：

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

[建議] 在 html 標簽上設置正確的 lang 屬性。

解釋：

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

示例：

<html lang="zh-CN">

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"。

示例：

<link rel="stylesheet" src="page.css">

[建議] 引入 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 應充分考慮頁面針對的環境。

示例：

<script src="http://s1.bdstatic.com/cache/static/jquery-1.10.2.min_f2fb5194.js"></script>

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。

示例：

<link rel="shortcut icon" href="path/to/favicon.ico">

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 屬性。

解釋：

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

示例：

<input type="date">

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 標簽內部提供指示瀏覽器不支持該標簽的說明。

示例：

<object width="100" height="50" data="something.swf">DO NOT SUPPORT THIS TAG</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 $item@iteration is div by 5}
    </tr>
    <tr>
        {/if}
    {/foreach}
</tr>
</table>
最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • 問答題47 /72 常見瀏覽器兼容性問題與解決方案？ 參考答案 (1)瀏覽器兼容問題一：不同瀏覽器的標簽默認的外補...
    _Yfling閱讀 13,809評論 1贊 92
  • 1 代碼風格 1.1 縮進于換行 [強制] 使用4個空格作為一個縮進層級，不允許使用2個空格或者“tab”字符。 ...
    你說的獨品閱讀 444評論 0贊 0
  • HTML編碼規范 1 代碼風格 1.1 縮進與換行 [強制] 使用 4 個空格做為一個縮進層級，不允許使用 2 個...
    東東丶醬閱讀 583評論 0贊 3
  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具（例如配置管理，服務發現，斷路器，智...
    卡卡羅2017閱讀 134,981評論 19贊 139
  • 能夠認識你，真好 汪國真 不知多少次 暗中期待 只為心中...
    尚小薰閱讀 418評論 0贊 0