本文來自:百度FEX
1 前言
HTML 作為描述網(wǎng)頁結(jié)構(gòu)的超文本標(biāo)記語言恐锣,在百度一直有著廣泛的應(yīng)用大州。本文檔的目標(biāo)是使 HTML 代碼風(fēng)格保持一致括改,容易被理解和被維護(hù)错邦。
2 代碼風(fēng)格
2.1 縮進(jìn)與換行
[強(qiáng)制] 使用 4
個空格做為一個縮進(jìn)層級探赫,不允許使用 2
個空格 或 tab
字符。
解釋:對于非 HTML 標(biāo)簽之間的縮進(jìn)撬呢,比如 script 或 style 標(biāo)簽內(nèi)容縮進(jìn)伦吠,與 script 或 style 標(biāo)簽的縮進(jìn)同級。
<style>
/* 樣式內(nèi)容的第一級縮進(jìn)與所屬的 style 標(biāo)簽對齊 */
ul {
padding: 0;
}
</style>
<ul>
<li>first</li>
<li>second</li>
</ul>
<script>
// 腳本代碼的第一級縮進(jìn)與所屬的 script 標(biāo)簽對齊
require(['app'], function (app) {
app.init();
});
</script>
[建議] 每行不得超過 120
個字符魂拦。
解釋:過長的代碼不容易閱讀與維護(hù)毛仪。但是考慮到 HTML 的特殊性,不做硬性要求芯勘。
2.2 命名
[強(qiáng)制] class
必須單詞全字母小寫箱靴,單詞間以 -
分隔。
[強(qiáng)制] class
必須代表相應(yīng)模塊或部件的內(nèi)容或功能荷愕,不得以樣式信息進(jìn)行命名衡怀。
<!-- good -->
<div class="sidebar"></div>
<!-- bad -->
<div class="left"></div>
[強(qiáng)制] 元素 id
必須保證頁面唯一。
解釋:同一個頁面中安疗,不同的元素包含相同的 id
抛杨,不符合 id
的屬性含義。并且使用 document.getElementById
時可能導(dǎo)致難以追查的問題茂契。
[建議] id
建議單詞全字母小寫蝶桶,單詞間以 -
分隔。同項(xiàng)目必須保持風(fēng)格一致掉冶。
[建議] 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>
[強(qiáng)制] 禁止為了 hook 腳本
恢共,創(chuàng)建無樣式信息的 class
。
解釋:不允許 class
只用于讓 JavaScript 選擇某些元素璧亚,class
應(yīng)該具有明確的語義和樣式讨韭。否則容易導(dǎo)致 CSS class 泛濫。
使用 id
癣蟋、屬性選擇作為 hook 是更好的方式透硝。
[強(qiáng)制] 同一頁面,應(yīng)避免使用相同的 name
與 id
疯搅。
解釋:IE 瀏覽器會混淆元素的 id
和 name
屬性濒生, document.getElementById
可能獲得不期望的元素。所以在對元素的 id
與 name
屬性的命名需要非常小心幔欧。
一個比較好的實(shí)踐是罪治,為 id
和 name
使用不同的命名法丽声。
<input name="foo">
<div id="foo"></div>
<script>
// IE6 將顯示 INPUT
alert(document.getElementById('foo').tagName);
</script>
2.3 標(biāo)簽
[強(qiáng)制] 標(biāo)簽名必須使用小寫字母。
<!-- good -->
<p>Hello StyleGuide!</p>
<!-- bad -->
<P>Hello StyleGuide!</P>
[強(qiáng)制] 對于無需自閉合的標(biāo)簽觉义,不允許自閉合雁社。
解釋:常見無需自閉合標(biāo)簽有 input
、br
晒骇、img
霉撵、hr
等。
<!-- good -->
<input type="text" name="title">
<!-- bad -->
<input type="text" name="title" />
[強(qiáng)制] 對 HTML5
中規(guī)定允許省略的閉合標(biāo)簽厉碟,不允許省略閉合標(biāo)簽喊巍。
解釋:對代碼體積要求非常嚴(yán)苛的場景,可以例外箍鼓。比如:第三方頁面使用的投放系統(tǒng)崭参。
<!-- good -->
<ul>
<li>first</li>
<li>second</li>
</ul>
<!-- bad -->
<ul>
<li>first
<li>second
</ul>
[強(qiáng)制] 標(biāo)簽使用必須符合標(biāo)簽嵌套規(guī)則。
解釋:比如 div
不得置于 p
中款咖,tbody
必須置于 table
中何暮。詳細(xì)的標(biāo)簽嵌套規(guī)則參見HTML DTD中的 Elements
定義部分。
[建議] HTML 標(biāo)簽的使用應(yīng)該遵循標(biāo)簽的語義铐殃。
解釋:下面是常見標(biāo)簽語義
- p - 段落
- h1,h2,h3,h4,h5,h6 - 層級標(biāo)題
- strong,em - 強(qiáng)調(diào)
- ins - 插入
- del - 刪除
- abbr - 縮寫
- code - 代碼標(biāo)識
- cite - 引述來源作品的標(biāo)題
- 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 可以實(shí)現(xiàn)相同需求的情況下不得使用表格進(jìn)行布局海洼。
解釋:在兼容性允許的情況下應(yīng)盡量保持語義正確性。對網(wǎng)格對齊和拉伸性有嚴(yán)格要求的場景允許例外富腊,如多列復(fù)雜表單坏逢。
[建議] 標(biāo)簽的使用應(yīng)盡量簡潔,減少不必要的標(biāo)簽赘被。
<!-- good -->
<img class="avatar" src="image.png">
<!-- bad -->
<span class="avatar">
<img src="image.png">
</span>
2.4 屬性
[強(qiáng)制] 屬性名必須使用小寫字母是整。
<!-- good -->
<table cellspacing="0">...</table>
<!-- bad -->
<table cellSpacing="0">...</table>
[強(qiáng)制] 屬性值必須用雙引號包圍。
解釋:不允許使用單引號民假,不允許不使用引號浮入。
<!-- 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-
。
解釋:使用前綴有助于區(qū)分自定義屬性和標(biāo)準(zhǔn)定義的屬性野舶。
<ol data-ui-type="Select"></ol>
3 通用
3.1 DOCTYPE
[強(qiáng)制] 使用 HTML5
的 doctype
來啟用標(biāo)準(zhǔn)模式易迹,建議使用大寫的 DOCTYPE
。
<!DOCTYPE html>
[建議] 啟用 IE Edge 模式平道。
<meta http-equiv="X-UA-Compatible" content="IE=Edge">
[建議] 在 html
標(biāo)簽上設(shè)置正確的 lang
屬性赴蝇。
解釋:有助于提高頁面的可訪問性,如:讓語音合成工具確定其所應(yīng)該采用的發(fā)音巢掺,令翻譯工具確定其翻譯語言等句伶。
<html lang="zh-CN">
3.2 編碼
[強(qiáng)制] 頁面必須使用精簡形式,明確指定字符編碼陆淀。指定字符編碼的 meta
必須是 head
的第一個直接子元素考余。
<html>
<head>
<meta charset="UTF-8">
......
</head>
<body>
......
</body>
</html>
[建議] HTML
文件使用無 BOM
的 UTF-8
編碼。
解釋:UTF-8
編碼具有更廣泛的適應(yīng)性轧苫。BOM
在使用程序或工具處理文件時可能造成不必要的干擾楚堤。
3.3 CSS 和 JavaScript 引入
[強(qiáng)制] 引入 CSS
時必須指明 rel="stylesheet"
。
<link rel="stylesheet" href="page.css">
[建議] 引入 CSS
和 JavaScript
時無須指明 type
屬性含懊。
解釋:text/css
和 text/javascript
是 type
的默認(rèn)值身冬。
[建議] 展現(xiàn)定義放置于外部 CSS
中,行為定義放置于外部 JavaScript
中岔乔。
解釋:結(jié)構(gòu)-樣式-行為的代碼分離酥筝,對于提高代碼的可閱讀性和維護(hù)性都有好處。
[建議] 在 head
中引入頁面需要的所有 CSS
資源雏门。
解釋:在頁面渲染的過程中嘿歌,新的CSS可能導(dǎo)致元素的樣式重新計(jì)算和繪制,頁面閃爍茁影。
[建議] JavaScript
應(yīng)當(dāng)放在頁面末尾宙帝,或采用異步加載。
解釋:將 script
放在頁面中間將阻斷頁面的渲染募闲。出于性能方面的考慮步脓,如非必要,請遵守此條建議浩螺。
<body>
<!-- a lot of elements -->
<script src="init-behavior.js"></script>
</body>
[建議] 移動環(huán)境或只針對現(xiàn)代瀏覽器設(shè)計(jì)的 Web 應(yīng)用靴患,如果引用外部資源的 URL
協(xié)議部分與頁面相同,建議省略協(xié)議前綴年扩。
解釋:使用 protocol-relative URL
引入 CSS蚁廓,在 IE7/8
下,會發(fā)兩次請求厨幻。是否使用 protocol-relative URL
應(yīng)充分考慮頁面針對的環(huán)境相嵌。
<script src="http://s1.bdstatic.com/cache/static/jquery-1.10.2.min_f2fb5194.js"></script>
4 head
4.1 title
[強(qiáng)制] 頁面必須包含 title
標(biāo)簽聲明標(biāo)題。
[強(qiáng)制] title
必須作為 head
的直接子元素况脆,并緊隨 charset
聲明之后饭宾。
解釋:title
中如果包含 ASCII 之外的字符,瀏覽器需要知道字符編碼類型才能進(jìn)行解碼格了,否則可能導(dǎo)致亂碼看铆。
<head>
<meta charset="UTF-8">
<title>頁面標(biāo)題</title>
</head>
4.2 favicon
[強(qiáng)制] 保證 favicon
可訪問。
解釋:在未指定 favicon 時盛末,大多數(shù)瀏覽器會請求 Web Server 根目錄下的 favicon.ico
弹惦。為了保證 favicon 可訪問否淤,避免 404,必須遵循以下兩種方法之一:
- 在 Web Server 根目錄放置
favicon.ico
文件棠隐。 - 使用
link
指定 favicon石抡。
<link rel="shortcut icon" href="path/to/favicon.ico">
4.3 viewport
[建議] 若頁面欲對移動設(shè)備友好,需指定頁面的 viewport
助泽。
解釋:viewport meta tag 可以設(shè)置可視區(qū)域的寬度和初始縮放大小啰扛,避免在移動設(shè)備上出現(xiàn)頁面展示不正常。
比如嗡贺,在頁面寬度小于 980px
時隐解,若需 iOS 設(shè)備友好,應(yīng)當(dāng)設(shè)置 viewport 的 width
值來適應(yīng)你的頁面寬度诫睬。同時因?yàn)椴煌苿釉O(shè)備分辨率不同煞茫,在設(shè)置時,應(yīng)當(dāng)使用 device-width
和 device-height
變量岩臣。
另外溜嗜,為了使 viewport 正常工作,在頁面內(nèi)容樣式布局設(shè)計(jì)上也要做相應(yīng)調(diào)整架谎,如避免絕對定位等炸宵。關(guān)于 viewport 的更多介紹,可以參見 Safari Web Content Guide的介紹
5 圖片
[強(qiáng)制] 禁止 img
的 src
取值為空谷扣。延遲加載的圖片也要增加默認(rèn)的 src
土全。
解釋:src
取值為空,會導(dǎo)致部分瀏覽器重新加載一次當(dāng)前頁面会涎,參考:https://developer.yahoo.com/performance/rules.html#emptysrc
[建議] 避免為 img
添加不必要的 title
屬性裹匙。
解釋:多余的 title
影響看圖體驗(yàn),并且增加了頁面尺寸末秃。
[建議] 為重要圖片添加 alt
屬性概页。
解釋:可以提高圖片加載失敗時的用戶體驗(yàn)。
[建議] 添加 width
和 height
屬性练慕,以避免頁面抖動惰匙。
[建議] 有下載需求的圖片采用 img
標(biāo)簽實(shí)現(xiàn),無下載需求的圖片采用 CSS 背景圖實(shí)現(xiàn)铃将。
解釋:產(chǎn)品 logo项鬼、用戶頭像、用戶產(chǎn)生的圖片等有潛在下載需求的圖片劲阎,以 img
形式實(shí)現(xiàn)绘盟,能方便用戶下載。 無下載需求的圖片,比如:icon龄毡、背景吠卷、代碼使用的圖片等,盡可能采用 CSS 背景圖實(shí)現(xiàn)稚虎。
6 表單
6.1 控件標(biāo)題
[強(qiáng)制] 有文本標(biāo)題的控件必須使用 label
標(biāo)簽將其與其標(biāo)題相關(guān)聯(lián)撤嫩。
解釋:有兩種方式:
- 將控件置于
label
內(nèi)。 -
label
的for
屬性指向控件的id
蠢终。
推薦使用第一種,減少不必要的 id
茴她。如果 DOM 結(jié)構(gòu)不允許直接嵌套寻拂,則應(yīng)使用第二種。
<label><input type="checkbox" name="confirm" value="on"> 我已確認(rèn)上述條款</label>
<label for="username">用戶名:</label> <input type="textbox" name="username" id="username">
6.2 按鈕
[強(qiáng)制] 使用 button
元素時必須指明 type
屬性值丈牢。
解釋:button
元素的默認(rèn) type
為 submit
祭钉,如果被置于 form
元素中,點(diǎn)擊后將導(dǎo)致表單提交己沛。為顯示區(qū)分其作用方便理解慌核,必須給出 type
屬性。
<button type="submit">提交</button>
<button type="button">取消</button>
[建議] 盡量不要使用按鈕類元素的 name
屬性申尼。
解釋:由于瀏覽器兼容性問題垮卓,使用按鈕的 name
屬性會帶來許多難以發(fā)現(xiàn)的問題。具體情況可參考此文师幕。
6.3 可訪問性 (A11Y)
[建議] 負(fù)責(zé)主要功能的按鈕在 DOM 中的順序應(yīng)靠前粟按。
解釋:負(fù)責(zé)主要功能的按鈕應(yīng)相對靠前,以提高可訪問性霹粥。如果在 CSS 中指定了 float: right
則可能導(dǎo)致視覺上主按鈕在前灭将,而 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>
[建議] 當(dāng)使用 JavaScript 進(jìn)行表單提交時后控,如果條件允許庙曙,應(yīng)使原生提交功能正常工作。
解釋:當(dāng)瀏覽器 JS 運(yùn)行錯誤或關(guān)閉 JS 時浩淘,提交功能將無法工作捌朴。如果正確指定了 form
元素的 action
屬性和表單控件的 name
屬性時,提交仍可繼續(xù)進(jìn)行馋袜。
<form action="/login" method="post">
<p><input name="username" type="text" placeholder="用戶名"></p>
<p><input name="password" type="password" placeholder="密碼"></p>
</form>
[建議] 在針對移動設(shè)備開發(fā)的頁面時男旗,根據(jù)內(nèi)容類型指定輸入框的 type
屬性。
解釋:根據(jù)內(nèi)容類型指定輸入框類型欣鳖,能獲得能友好的輸入體驗(yàn)察皇。
<input type="date">
7 多媒體
[建議] 當(dāng)在現(xiàn)代瀏覽器中使用 audio
以及 video
標(biāo)簽來播放音頻、視頻時,應(yīng)當(dāng)注意格式什荣。
音頻應(yīng)盡可能覆蓋到如下格式:
- MP3
- WAV
- Ogg
視頻應(yīng)盡可能覆蓋到如下格式:
- MP4
- WebM
- Ogg
[建議] 在支持 HTML5
的瀏覽器中優(yōu)先使用 audio
和 video
標(biāo)簽來定義音視頻元素矾缓。
[建議] 使用退化到插件的方式來對多瀏覽器進(jìn)行支持。
<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
標(biāo)簽內(nèi)部提供指示瀏覽器不支持該標(biāo)簽的說明嗜闻。
<object width="100" height="50" data="something.swf">DO NOT SUPPORT THIS TAG</object>
8 模板中的 HTML
[建議] 模板代碼的縮進(jìn)優(yōu)先保證 HTML 代碼的縮進(jìn)規(guī)則。
<!-- 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}
[建議] 模板代碼應(yīng)以保證 HTML 單個標(biāo)簽語法的正確性為基本原則桅锄。
<!-- 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>
[建議] 在循環(huán)處理模板數(shù)據(jù)構(gòu)造表格時琉雳,若要求每行輸出固定的個數(shù),建議先將數(shù)據(jù)分組友瘤,之后再循環(huán)輸出翠肘。
<!-- 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>