本篇內(nèi)容介紹了“HTML編碼規(guī)范實(shí)例分析”的有關(guān)知識,在實(shí)際案例的操作過程中,不少人都會遇到這樣的困境,接下來就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧!希望大家仔細(xì)閱讀,能夠?qū)W有所成!
創(chuàng)新互聯(lián)建站主營望都網(wǎng)站建設(shè)的網(wǎng)絡(luò)公司,主營網(wǎng)站建設(shè)方案,成都App定制開發(fā),望都h5微信平臺小程序開發(fā)搭建,望都網(wǎng)站營銷推廣歡迎望都等地區(qū)企業(yè)咨詢
HTML編碼規(guī)范
本文檔的目標(biāo)是使HTML代碼風(fēng)格保持一致,容易被理解和被維護(hù),如果自己沒有這種習(xí)慣,請好好選擇你的IDE,別再用“文本編輯器”。
1 代碼風(fēng)格
1.1 縮進(jìn)與換行
[強(qiáng)制] 使用 4 個(gè)空格做為一個(gè)縮進(jìn)層級,不允許使用 2 個(gè)空格 或 tab 字符。
示例:
[建議] 每行不得超過 120 個(gè)字符。
解釋:
過長的代碼不容易閱讀與維護(hù)。但是考慮到 HTML 的特殊性,不做硬性要求,sublime、phpstorm、wenstorm等都有標(biāo)尺功能。
1.2 命名
[強(qiáng)制] class 必須單詞全字母小寫,單詞間以 - 分隔。
[強(qiáng)制] class 必須代表相應(yīng)模塊或部件的內(nèi)容或功能,不得以樣式信息進(jìn)行命名。
示例:
[強(qiáng)制] 元素 id 必須保證頁面唯一。
解釋:
同一個(gè)頁面中,不同的元素包含相同的 id,不符合 id 的屬性含義。并且使用 document.getElementById 時(shí)可能導(dǎo)致難以追查的問題。
[建議] id 建議單詞全字母小寫,單詞間以 - 分隔。同項(xiàng)目必須保持風(fēng)格一致。
[建議] id、class 命名,在避免沖突并描述清楚的前提下盡可能短。
示例:
[強(qiáng)制] 同一頁面,應(yīng)避免使用相同的 name 與 id。
解釋:
IE 瀏覽器會混淆元素的 id 和 name 屬性, document.getElementById 可能獲得不期望的元素。所以在對元素的 id 與 name 屬性的命名需要非常小心。
一個(gè)比較好的實(shí)踐是,為 id 和 name 使用不同的命名法。
示例:
1.3 標(biāo)簽
[強(qiáng)制] 標(biāo)簽名必須使用小寫字母。
示例:
Hello StyleGuide!
Hello StyleGuide!
[強(qiáng)制] 對于無需自閉合的標(biāo)簽,不允許自閉合。
解釋:
常見無需自閉合標(biāo)簽有input、br、img、hr等。
示例:
[強(qiáng)制] 對 HTML5 中規(guī)定允許省略的閉合標(biāo)簽,不允許省略閉合標(biāo)簽。
示例:
[強(qiáng)制] 標(biāo)簽使用必須符合標(biāo)簽嵌套規(guī)則。
解釋:
比如 div 不得置于 p 中,tbody 必須置于 table 中。
示例:
[建議] HTML 標(biāo)簽的使用應(yīng)該遵循標(biāo)簽的語義。
解釋:
下面是常見標(biāo)簽語義
p - 段落h2,h3,h4,h5,h6,h7 - 層級標(biāo)題strong,em - 強(qiáng)調(diào)ins - 插入del - 刪除abbr - 縮寫code - 代碼標(biāo)識cite - 引述來源作品的標(biāo)題q - 引用blockquote - 一段或長篇引用ul - 無序列表ol - 有序列表dl,dt,dd - 定義列表
示例:
Esprima serves as an important building block for some JavaScript language tools.
Esprima serves as an important building block for some JavaScript language tools.
[建議] 在 CSS 可以實(shí)現(xiàn)相同需求的情況下不得使用表格進(jìn)行布局。
解釋:
在兼容性允許的情況下應(yīng)盡量保持語義正確性。對網(wǎng)格對齊和拉伸性有嚴(yán)格要求的場景允許例外,如多列復(fù)雜表單。
[建議] 標(biāo)簽的使用應(yīng)盡量簡潔,減少不必要的標(biāo)簽。
示例:
1.4 屬性
[強(qiáng)制] 屬性名必須使用小寫字母。
示例:
[強(qiáng)制] 屬性值必須用雙引號包圍。
解釋:
不允許使用單引號,不允許不使用引號。
示例:
[建議] 布爾類型的屬性,建議不添加屬性值。
示例:
[建議] 自定義屬性建議以 xxx- 為前綴,推薦使用 data-。
解釋:
使用前綴有助于區(qū)分自定義屬性和標(biāo)準(zhǔn)定義的屬性。
示例:
2 通用
2.1 DOCTYPE
[強(qiáng)制] 使用 HTML5 的 doctype 來啟用標(biāo)準(zhǔn)模式,建議使用大寫的 DOCTYPE。
示例:
[建議] 啟用 IE Edge 和 Chrome Frame 模式。
示例:
[建議] 在 html 標(biāo)簽上設(shè)置正確的 lang 屬性。
解釋:
有助于提高頁面的可訪問性,如:讓語音合成工具確定其所應(yīng)該采用的發(fā)音,令翻譯工具確定其翻譯語言等。
示例:
[建議] 開啟雙核瀏覽器的 webkit 內(nèi)核進(jìn)行渲染。
解釋:
見瀏覽器內(nèi)核控制Meta標(biāo)簽說明文檔 一文。
示例:
[建議] 開啟瀏覽器的DNS預(yù)獲取。
解釋:
減少DNS請求次數(shù)、對DNS進(jìn)行預(yù)獲取。
示例:
2.2 編碼
[強(qiáng)制] 頁面必須使用精簡形式,明確指定字符編碼。指定字符編碼的 meta 必須是 head 的第一個(gè)直接子元素。
解釋:
見 HTML5 Charset能用嗎 一文。
示例:
...... ......
[建議] HTML 文件使用無 BOM 的 UTF-8 編碼。
解釋:
UTF-8 編碼具有更廣泛的適應(yīng)性。BOM 在使用程序或工具處理文件時(shí)可能造成不必要的干擾。
2.3 CSS和JavaScript引入
[強(qiáng)制] 引入 CSS 時(shí)必須指明 rel="stylesheet"。
示例:
[建議] 引入 CSS 和 JavaScript 時(shí)無須指明 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 放在頁面中間將阻斷頁面的渲染。出于性能方面的考慮,如非必要,請遵守此條建議。
示例:
[強(qiáng)制] 引用靜態(tài)資源的 URL 協(xié)議部分與頁面相同,建議省略協(xié)議前綴。
示例:
3 Head
3.1 title
[強(qiáng)制] 頁面必須包含 title 標(biāo)簽聲明標(biāo)題。
[強(qiáng)制] title 必須作為 head 的直接子元素,并緊隨 聲明之后。
解釋:
title 中如果包含 ascii 之外的字符,瀏覽器需要知道字符編碼類型才能進(jìn)行解碼,否則可能導(dǎo)致亂碼。
示例:
頁面標(biāo)題
4 圖片
[強(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 屬性。
解釋:
可以提高圖片加載失敗時(shí)的用戶體驗(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)。
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)使用第二種。
示例:
5.2 按鈕
[強(qiáng)制] 使用 button 元素時(shí)必須指明 type 屬性值。
解釋:
button 元素的默認(rèn) type 為 submit,如果被置于 form 元素中,點(diǎn)擊后將導(dǎo)致表單提交。為顯示區(qū)分其作用方便理解,必須給出 type 屬性。
示例:
[建議] 盡量不要使用按鈕類元素的 name 屬性。
解釋:
由于瀏覽器兼容性問題,使用按鈕的 name 屬性會帶來許多難以發(fā)現(xiàn)的問題。具體情況可參考此文。
5.3 可訪問性 (A11Y)
[建議] 負(fù)責(zé)主要功能的按鈕在 DOM 中的順序應(yīng)靠前。
解釋:
負(fù)責(zé)主要功能的按鈕應(yīng)相對靠前,以提高可訪問性。如果在 CSS 中指定了 float: right 則可能導(dǎo)致視覺上主按鈕在前,而 DOM 中主按鈕靠后的情況。
示例:
[建議] 當(dāng)使用 JavaScript 進(jìn)行表單提交時(shí),如果條件允許,應(yīng)使原生提交功能正常工作。
解釋:
當(dāng)瀏覽器 JS 運(yùn)行錯(cuò)誤或關(guān)閉 JS 時(shí),提交功能將無法工作。如果正確指定了 form 元素的 action 屬性和表單控件的 name 屬性時(shí),提交仍可繼續(xù)進(jìn)行。
示例:
[建議] 在針對移動設(shè)備開發(fā)的頁面時(shí),根據(jù)內(nèi)容類型指定輸入框的 type 屬性。
解釋:
根據(jù)內(nèi)容類型指定輸入框類型,能獲得能友好的輸入體驗(yàn)。
示例:
6 模板中的 HTML
[建議] 模板代碼的縮進(jìn)優(yōu)先保證 HTML 代碼的縮進(jìn)規(guī)則。
示例:
- {name}
- {$item.name}
[建議] 模板代碼應(yīng)以保證 HTML 單個(gè)標(biāo)簽語法的正確性為基本原則。
示例:
[建議] 模板代碼應(yīng)以保證結(jié)束符的閉合名
示例:
- {name}:¥{unit_price}
- {name}:¥{unit_price}
[建議] 在循環(huán)處理模板數(shù)據(jù)構(gòu)造表格時(shí),若要求每行輸出固定的個(gè)數(shù),建議先將數(shù)據(jù)分組,之后再循環(huán)輸出,模板只是做數(shù)據(jù)展示,別加插太多業(yè)務(wù)邏輯(其他數(shù)據(jù)構(gòu)造同理)。
示例:
{name}:¥{unit_price} |
{name}:¥{unit_price} |
{name}:¥{price} |
{name}: ¥{unit_price} ¥{total_price} |
“HTML編碼規(guī)范實(shí)例分析”的內(nèi)容就介紹到這里了,感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識可以關(guān)注創(chuàng)新互聯(lián)網(wǎng)站,小編將為大家輸出更多高質(zhì)量的實(shí)用文章!