前端讀者 | 百度前端編碼規範（HTML）

時間  2019-12-10
標籤 前端 讀者 百度 編碼 規範 html 欄目 字符編碼 简体版
原文   原文鏈接

本文來自：百度FEXjavascript

1 前言

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

2 代碼風格

2.1 縮進與換行

[強制] 使用 4 個空格作爲一個縮進層級，不容許使用 2 個空格 或 tab 字符。html

解釋：對於非 HTML 標籤之間的縮進，好比 script 或 style 標籤內容縮進，與 script 或 style 標籤的縮進同級。html5

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

[建議] 每行不得超過 120 個字符。java

解釋：過長的代碼不容易閱讀與維護。可是考慮到 HTML 的特殊性，不作硬性要求。jquery

2.2 命名

[強制] class 必須單詞全字母小寫，單詞間以 - 分隔。瀏覽器

[強制] class 必須表明相應模塊或部件的內容或功能，不得以樣式信息進行命名。app

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

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

[強制] 元素 id 必須保證頁面惟一。異步

解釋：同一個頁面中，不一樣的元素包含相同的 id，不符合 id 的屬性含義。而且使用 document.getElementById 時可能致使難以追查的問題。ide

[建議] 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>

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

<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 的第一個直接子元素。

<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" href="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="//s1.bdstatic.com/cache/static/jquery-1.10.2.min_f2fb5194.js"></script>

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，必須遵循如下兩種方法之一：

  • 在 Web Server 根目錄放置 favicon.ico 文件。
  • 使用 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 背景圖實現。

解釋：產品 logo、用戶頭像、用戶產生的圖片等有潛在下載需求的圖片，以 img 形式實現，能方便用戶下載。 無下載需求的圖片，好比：icon、背景、代碼使用的圖片等，儘量採用 CSS 背景圖實現。

6 表單

6.1 控件標題

[強制] 有文本標題的控件必須使用 label 標籤將其與其標題相關聯。

解釋：有兩種方式：

  • 將控件置於 label 內。
  • 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>
相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程