HTML編碼規(guī)范
1 代碼風(fēng)格
1.1 縮進(jìn)與換行
[強(qiáng)制] 使用 4 個(gè)空格做為一個(gè)縮進(jìn)層級(jí)，不允許使用 2 個(gè)空格 或 tab 字符。
示例：
<ul>
<li>first</li>
<li>second</li>
</ul>
[建議] 每行不得超過 120 個(gè)字符。
解釋：
過長(zhǎng)的代碼不容易閱讀與維護(hù)。但是考慮到 HTML 的特殊性，不做硬性要求。
1.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 必須保證頁(yè)面唯一。
解釋：
同一個(gè)頁(yè)面中，不同的元素包含相同的 id，不符合 id 的屬性含義。并且使用 document.getElementById 時(shí)可能導(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>
1.3 標(biāo)簽
[強(qiáng)制] 標(biāo)簽名必須使用小寫字母。
示例：
<!-- good -->
<p>Hello StyleGuide!</p>
<!-- bad -->
<P>Hello StyleGuide!</P>
[強(qiáng)制] 對(duì)于無需自閉合的標(biāo)簽，不允許自閉合。
解釋：
常見無需自閉合標(biāo)簽有input、br、img、hr等。
示例：
<!-- good -->
<input type="text" name="title">
<!-- bad -->
<input type="text" name="title" />
[強(qiáng)制] 對(duì) HTML5 中規(guī)定允許省略的閉合標(biāo)簽，不允許省略閉合標(biāo)簽。
示例：
<!-- 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 - 層級(jí)標(biāo)題
- strong,em - 強(qiáng)調(diào)
- ins - 插入
- del - 刪除
- abbr - 縮寫
- code - 代碼標(biāo)識(shí)
- cite - 引述來源作品的標(biāo)題
- q - 引用
- blockquote - 一段或長(zhǎng)篇引用
- 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)盡量保持語義正確性。對(duì)網(wǎng)格對(duì)齊和拉伸性有嚴(yán)格要求的場(chǎng)景允許例外，如多列復(fù)雜表單。
[建議] 標(biāo)簽的使用應(yīng)盡量簡(jiǎn)潔，減少不必要的標(biāo)簽。
示例：
<!-- good -->
<!-- bad -->
<span class="avatar">
</span>
1.4 屬性
[強(qiáng)制] 屬性名必須使用小寫字母。
示例：
<!-- good -->
<table cellspacing="0">...</table>
<!-- bad -->
<table cellSpacing="0">...</table>
[強(qiáng)制] 屬性值必須用雙引號(hào)包圍。
解釋：
不允許使用單引號(hào)，不允許不使用引號(hào)。
示例：
<!-- 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>
2 通用
2.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è)面的可訪問性，如：讓語音合成工具確定其所應(yīng)該采用的發(fā)音，令翻譯工具確定其翻譯語言等。
示例：
<html lang="zh-CN">
2.2 編碼
[強(qiáng)制] 頁(yè)面必須使用精簡(jiǎn)形式，明確指定字符編碼。指定字符編碼的 meta 必須是 head 的第一個(gè)直接子元素。
解釋：
見 HTML5 Charset能用嗎 一文。
示例：
<html>
<head>
<meta charset="UTF-8">
......
</head>
<body>
......
</body>
</html>
[建議] HTML 文件使用無 BOM 的 UTF-8 編碼。
解釋：
UTF-8 編碼具有更廣泛的適應(yīng)性。BOM 在使用程序或工具處理文件時(shí)可能造成不必要的干擾。
2.3 CSS和JavaScript引入
[強(qiáng)制] 引入 CSS 時(shí)必須指明 rel="stylesheet"。
示例：
<link rel="stylesheet" src="page.css">
[建議] 引入 CSS 和 JavaScript 時(shí)無須指明 type 屬性。
解釋：
text/css 和 text/javascript 是 type 的默認(rèn)值。
[建議] 展現(xiàn)定義放置于外部 CSS 中，行為定義放置于外部 JavaScript 中。
解釋：
結(jié)構(gòu)-樣式-行為的代碼分離，對(duì)于提高代碼的可閱讀性和維護(hù)性都有好處。
[建議] 在 head 中引入頁(yè)面需要的所有 CSS 資源。
解釋：
在頁(yè)面渲染的過程中，新的CSS可能導(dǎo)致元素的樣式重新計(jì)算和繪制，頁(yè)面閃爍。
[建議] JavaScript 應(yīng)當(dāng)放在頁(yè)面末尾，或采用異步加載。
解釋：
將 script 放在頁(yè)面中間將阻斷頁(yè)面的渲染。出于性能方面的考慮，如非必要，請(qǐng)遵守此條建議。
示例：
<body>
<!-- a lot of elements -->
<script src="init-behavior.js"></script>
</body>
[建議] 移動(dòng)環(huán)境或只針對(duì)現(xiàn)代瀏覽器設(shè)計(jì)的 Web 應(yīng)用，如果引用外部資源的 URL 協(xié)議部分與頁(yè)面相同，建議省略協(xié)議前綴。
解釋：
使用 protocol-relative URL 引入 CSS，在 IE7/8 下，會(huì)發(fā)兩次請(qǐng)求。是否使用 protocol-relative URL 應(yīng)充分考慮頁(yè)面針對(duì)的環(huán)境。
示例：
<script src="http://s1.bdstatic.com/cache/static/jquery-1.10.2.min_f2fb5194.js"></script>
3 head
3.1 title
[強(qiáng)制] 頁(yè)面必須包含 title 標(biāo)簽聲明標(biāo)題。
[強(qiáng)制] title 必須作為 head 的直接子元素，并緊隨 charset 聲明之后。
解釋：
title 中如果包含 ascii 之外的字符，瀏覽器需要知道字符編碼類型才能進(jìn)行解碼，否則可能導(dǎo)致亂碼。
示例：
<head>
<meta charset="UTF-8">
<title>頁(yè)面標(biāo)題</title>
</head>
3.2 favicon
[強(qiáng)制] 保證 favicon 可訪問。
解釋：
在未指定 favicon 時(shí)，大多數(shù)瀏覽器會(huì)請(qǐng)求 Web Server 根目錄下的 favicon.ico 。為了保證favicon可訪問，避免404，必須遵循以下兩種方法之一：
- 在 Web Server 根目錄放置 favicon.ico 文件。
- 使用 link 指定 favicon。
示例：
<link rel="shortcut icon" href="path/to/favicon.ico">
3.3 viewport
[建議] 若頁(yè)面欲對(duì)移動(dòng)設(shè)備友好，需指定頁(yè)面的 viewport。
解釋：
viewport meta tag可以設(shè)置可視區(qū)域的寬度和初始縮放大小，避免在移動(dòng)設(shè)備上出現(xiàn)頁(yè)面展示不正常。
比如，在頁(yè)面寬度小于 980px 時(shí)，若需 iOS 設(shè)備友好，應(yīng)當(dāng)設(shè)置 viewport 的 width 值來適應(yīng)你的頁(yè)面寬度。同時(shí)因?yàn)椴煌苿?dòng)設(shè)備分辨率不同，在設(shè)置時(shí)，應(yīng)當(dāng)使用 device-width 和 device-height 變量。
另外，為了使 viewport 正常工作，在頁(yè)面內(nèi)容樣式布局設(shè)計(jì)上也要做相應(yīng)調(diào)整，如避免絕對(duì)定位等。關(guān)于 viewport 的更多介紹，可以參見 Safari Web Content Guide的介紹
4 圖片
[強(qiáng)制] 禁止 img 的 src 取值為空。延遲加載的圖片也要增加默認(rèn)的 src。
解釋：
src 取值為空，會(huì)導(dǎo)致部分瀏覽器重新加載一次當(dāng)前頁(yè)面，參考：https://developer.yahoo.com/performance/rules.html#emptysrc
[建議] 避免為 img 添加不必要的 title 屬性。
解釋：
多余的 title 影響看圖體驗(yàn)，并且增加了頁(yè)面尺寸。
[建議] 為重要圖片添加 alt 屬性。
解釋：
可以提高圖片加載失敗時(shí)的用戶體驗(yàn)。
[建議] 添加 width 和 height 屬性，以避免頁(yè)面抖動(dòng)。
[建議] 有下載需求的圖片采用 img 標(biāo)簽實(shí)現(xiàn)，無下載需求的圖片采用 CSS 背景圖實(shí)現(xiàn)。
解釋：
- 產(chǎn)品 logo、用戶頭像、用戶產(chǎn)生的圖片等有潛在下載需求的圖片，以 img 形式實(shí)現(xiàn)，能方便用戶下載。
- 無下載需求的圖片，比如：icon、背景、代碼使用的圖片等，盡可能采用 css 背景圖實(shí)現(xiàn)。
5 表單
5.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">
5.2 按鈕
[強(qiáng)制] 使用 button 元素時(shí)必須指明 type 屬性值。
解釋：
button 元素的默認(rèn) type 為 submit，如果被置于 form 元素中，點(diǎn)擊后將導(dǎo)致表單提交。為顯示區(qū)分其作用方便理解，必須給出 type 屬性。
示例：
<button type="submit">提交</button>
<button type="button">取消</button>
[建議] 盡量不要使用按鈕類元素的 name 屬性。
解釋：
由于瀏覽器兼容性問題，使用按鈕的 name 屬性會(huì)帶來許多難以發(fā)現(xiàn)的問題。具體情況可參考此文。
[建議] 在針對(duì)移動(dòng)設(shè)備開發(fā)的頁(yè)面時(shí)，根據(jù)內(nèi)容類型指定輸入框的 type 屬性。
解釋：
根據(jù)內(nèi)容類型指定輸入框類型，能獲得能友好的輸入體驗(yàn)。
示例：
<input type="date">
6 模板中的 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 單個(gè)標(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í)，若要求每行輸出固定的個(gè)數(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>
