溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務條款》

HTML編碼規(guī)范是什么

發(fā)布時間:2020-10-23 15:40:51 來源:億速云 閱讀:96 作者:小新 欄目:web開發(fā)

HTML編碼規(guī)范是什么?這個問題可能是我們?nèi)粘W習或工作經(jīng)常見到的。希望通過這個問題能讓你收獲頗深。下面是小編給大家?guī)淼膮⒖純?nèi)容,讓我們一起來看看吧!

HTML編碼規(guī)范

本文檔的目標是使HTML代碼風格保持一致,容易被理解和被維護,如果自己沒有這種習慣,請好好選擇你的IDE,別再用“文本編輯器”。

1 代碼風格

1.1 縮進與換行

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

示例:

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

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

解釋:

過長的代碼不容易閱讀與維護。但是考慮到 HTML 的特殊性,不做硬性要求,sublime、phpstorm、wenstorm等都有標尺功能。

1.2 命名

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

[強制] class 必須代表相應模塊或部件的內(nèi)容或功能,不得以樣式信息進行命名。

示例:

<!-- good -->
<div></div>
<!-- bad -->
<div></div>

[強制] 元素 id 必須保證頁面唯一。

解釋:

同一個頁面中,不同的元素包含相同的 id,不符合 id 的屬性含義。并且使用 document.getElementById 時可能導致難以追查的問題。

[建議] id 建議單詞全字母小寫,單詞間以 - 分隔。同項目必須保持風格一致。

[建議] id、class 命名,在避免沖突并描述清楚的前提下盡可能短。

示例:

<!-- good -->
<div id="nav"></div>
<!-- bad -->
<div id="navigation"></div>
<!-- good -->
<p></p>
<!-- bad -->
<p></p>
<!-- good -->
<span></span>
<!-- bad -->
<span></span>

[強制] 同一頁面,應避免使用相同的 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>

1.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 中規(guī)定允許省略的閉合標簽,不允許省略閉合標簽。

示例:

<!-- good -->
<ul>
    <li>first</li>
    <li>second</li>
</ul>
<!-- bad -->
<ul>
    <li>first
    <li>second
</ul>

[強制] 標簽使用必須符合標簽嵌套規(guī)則。

解釋:

比如 div 不得置于 p 中,tbody 必須置于 table 中。

示例:

<!-- good -->
<div><h2><span></span></h2></div>
<a href=""><span></span></a>
<!-- bad -->
<span><div></div></span>
<p><div></div></p>
<h2><div></div></h2>
<h7><div></div></h7>
<a href="a.html"><a href="a.html"></a></a>

[建議] HTML 標簽的使用應該遵循標簽的語義。

解釋:

下面是常見標簽語義

p - 段落
h2,h3,h4,h5,h6,h7 - 層級標題
strong,em - 強調(diào)
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>building block</span> for some JavaScript language tools.</div>

[建議] 在 CSS 可以實現(xiàn)相同需求的情況下不得使用表格進行布局。

解釋:

在兼容性允許的情況下應盡量保持語義正確性。對網(wǎng)格對齊和拉伸性有嚴格要求的場景允許例外,如多列復雜表單。

[建議] 標簽的使用應盡量簡潔,減少不必要的標簽。

示例:

<!-- good -->
<img src="image.png">
<!-- bad -->
<span>
    <img src="image.png">
</span>

1.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>

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

示例:

<!-- good -->
<input type="text" disabled>
<input type="checkbox" value="1" checked>
<!-- bad -->
<input type="text" disabled="disabled">
<input type="checkbox" value="1" checked="checked">

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

解釋:

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

示例:

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

2 通用

2.1 DOCTYPE

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

示例:

<!DOCTYPE html>

[建議] 啟用 IE Edge 和 Chrome Frame 模式。

示例:

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

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

解釋:

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

示例:

<html>

[建議] 開啟雙核瀏覽器的 webkit 內(nèi)核進行渲染。

解釋:

見瀏覽器內(nèi)核控制Meta標簽說明文檔 一文。

示例:

<meta name="renderer" content="webkit">

[建議] 開啟瀏覽器的DNS預獲取。

解釋:

減少DNS請求次數(shù)、對DNS進行預獲取。

示例:

<link rel="dns-prefetch" href="//global.zuzuche.com/">
<link rel="dns-prefetch" href="//imgcdn1.zuzuche.com/">
<link rel="dns-prefetch" href="//qiniucdn.com/">

2.2 編碼

[強制] 頁面必須使用精簡形式,明確指定字符編碼。指定字符編碼的 meta 必須是 head 的第一個直接子元素。

解釋:

見 HTML5 Charset能用嗎 一文。

示例:

<html>
    <head>
        <meta charset="UTF-8">
        ......
    </head>
    <body>
        ......
    </body>
</html>

[建議] HTML 文件使用無 BOM 的 UTF-8 編碼。

解釋:

UTF-8 編碼具有更廣泛的適應性。BOM 在使用程序或工具處理文件時可能造成不必要的干擾。

2.3 CSS和JavaScript引入

[強制] 引入 CSS 時必須指明 rel="stylesheet"。

示例:

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

[建議] 引入 CSS 和 JavaScript 時無須指明 type 屬性。

解釋:

text/css 和 text/javascript 是 type 的默認值。

[建議] 展現(xiàn)定義放置于外部 CSS 中,行為定義放置于外部 JavaScript 中。

解釋:

結(jié)構(gòu)-樣式-行為的代碼分離,對于提高代碼的可閱讀性和維護性都有好處。

[建議] 在 head 中引入頁面需要的所有 CSS 資源。

解釋:

在頁面渲染的過程中,新的CSS可能導致元素的樣式重新計算和繪制,頁面閃爍。

[建議] JavaScript 應當放在頁面末尾,或采用異步加載。

解釋:

將 script 放在頁面中間將阻斷頁面的渲染。出于性能方面的考慮,如非必要,請遵守此條建議。

示例:

<body>
    <!-- a lot of elements -->
    <script src="init-behavior.js"></script>
</body>

[強制] 引用靜態(tài)資源的 URL 協(xié)議部分與頁面相同,建議省略協(xié)議前綴。

示例:

<script src="//global.zuzuche.com/assets/js/gallery/jquery/1.11.2/jquery.js"></script>

3 Head

3.1 title

[強制] 頁面必須包含 title 標簽聲明標題。

[強制] title 必須作為 head 的直接子元素,并緊隨 <link rel="dns-prefetch"> 聲明之后。

解釋:

title 中如果包含 ascii 之外的字符,瀏覽器需要知道字符編碼類型才能進行解碼,否則可能導致亂碼。

示例:

<head>
    <meta charset="UTF-8">
    <link rel="dns-prefetch" href="//global.zuzuche.com/">
    <link rel="dns-prefetch" href="//imgcdn1.zuzuche.com/">
    <link rel="dns-prefetch" href="//qiniucdn.com/">
    <title>頁面標題</title>
</head>

4 圖片

[強制] 禁止 img 的 src 取值為空。延遲加載的圖片也要增加默認的 src。

解釋:

src 取值為空,會導致部分瀏覽器重新加載一次當前頁面,參考:

https://developer.yahoo.com/performance/rules.html#emptysrc

[建議] 避免為 img 添加不必要的 title 屬性。

解釋:

多余的 title 影響看圖體驗,并且增加了頁面尺寸。

[建議] 為重要圖片添加 alt 屬性。

解釋:

可以提高圖片加載失敗時的用戶體驗。

[建議] 添加 width 和 height 屬性,以避免頁面抖動。

[建議] 有下載需求的圖片采用 img 標簽實現(xiàn),無下載需求的圖片采用 CSS 背景圖實現(xiàn)。

解釋:

產(chǎn)品 logo、用戶頭像、用戶產(chǎn)生的圖片等有潛在下載需求的圖片,以 img 形式實現(xiàn),能方便用戶下載。

無下載需求的圖片,比如:icon、背景、代碼使用的圖片等,盡可能采用 css 背景圖實現(xiàn)。

5 表單

5.1 控件標題

[強制] 有文本標題的控件必須使用 label 標簽將其與其標題相關聯(lián)。

解釋:

有兩種方式:

將控件置于 label 內(nèi)。

label 的 for 屬性指向控件的 id。

推薦使用第一種,減少不必要的 id。如果 DOM 結(jié)構(gòu)不允許直接嵌套,則應使用第二種。

示例:

<label><input type="checkbox" name="confirm" value="on"> 我已確認上述條款</label>
<label for="username">用戶名:</label> <input type="textbox" name="username" id="username">

5.2 按鈕

[強制] 使用 button 元素時必須指明 type 屬性值。

解釋:

button 元素的默認 type 為 submit,如果被置于 form 元素中,點擊后將導致表單提交。為顯示區(qū)分其作用方便理解,必須給出 type 屬性。

示例:

<button type="submit">提交</button>
<button type="button">取消</button>

[建議] 盡量不要使用按鈕類元素的 name 屬性。

解釋:

由于瀏覽器兼容性問題,使用按鈕的 name 屬性會帶來許多難以發(fā)現(xiàn)的問題。具體情況可參考此文。

5.3 可訪問性 (A11Y)

[建議] 負責主要功能的按鈕在 DOM 中的順序應靠前。

解釋:

負責主要功能的按鈕應相對靠前,以提高可訪問性。如果在 CSS 中指定了 float: right 則可能導致視覺上主按鈕在前,而 DOM 中主按鈕靠后的情況。

示例:

<!-- good -->
<style>
.buttons .button-group {
    float: right;
}
</style>
<div>
    <div>
        <button type="submit">提交</button>
        <button type="button">取消</button>
    </div>
</div>
<!-- bad -->
<style>
.buttons button {
    float: right;
}
</style>
<div>
    <button type="button">取消</button>
    <button type="submit">提交</button>
</div>

[建議] 當使用 JavaScript 進行表單提交時,如果條件允許,應使原生提交功能正常工作。

解釋:

當瀏覽器 JS 運行錯誤或關閉 JS 時,提交功能將無法工作。如果正確指定了 form 元素的 action 屬性和表單控件的 name 屬性時,提交仍可繼續(xù)進行。

示例:

<form action="/login" method="post">
    <p><input name="username" type="text" placeholder="用戶名"></p>
    <p><input name="password" type="password" placeholder="密碼"></p>
</form>

[建議] 在針對移動設備開發(fā)的頁面時,根據(jù)內(nèi)容類型指定輸入框的 type 屬性。

解釋:

根據(jù)內(nèi)容類型指定輸入框類型,能獲得能友好的輸入體驗。

示例:

<input type="date">
<input type="tel">
<input type="number">
<input type="number" pattern="\d*">

6 模板中的 HTML

[建議] 模板代碼的縮進優(yōu)先保證 HTML 代碼的縮進規(guī)則。

示例:

<!-- good -->
<!-- IF is_display -->
<div>
    <ul>
        <!-- BEGIN item_list -->
        <li>{name}<li>
        <!-- END item_list -->
    </ul>
</div>
<!-- ENDIF item_list -->
<!-- bad -->
<!-- IF is_display -->
    <div>
        <ul>
    <!-- BEGIN item_list -->
        <li>{$item.name}<li>
    <!-- END item_list -->
        </ul>
    </div>
<!-- ENDIF item_list -->

[建議] 模板代碼應以保證 HTML 單個標簽語法的正確性為基本原則。

示例:

<!-- good -->
<li class="<!-- IF selected --> selected<!-- ENDIF selected -->">{type_name}</li>
<!-- bad -->
<li <!-- IF selected --><!-- ENDIF selected -->>{type_name}</li>

[建議] 模板代碼應以保證結(jié)束符的閉合名

示例:

<!-- good -->
<!-- IF is_display -->
<div>
    <!-- BEGIN item_list -->
    <ul>
        <!-- BEGIN package_list -->
        <li>
            <span>{name}:</span><span>¥{unit_price}</span>
        <li>
        <!-- END package_list -->
    </ul>
    <!-- END item_list -->
</div>
<!-- ENDIF is_display -->
<!-- bad -->
<!-- IF is_display -->
<div>
    <!-- BEGIN item_list -->
    <ul>
        <!-- BEGIN package_list -->
        <li>
            <span>{name}:</span><span>¥{unit_price}</span>
        <li>
        <!-- END -->
    </ul>
    <!-- END -->
</div>
<!-- ENDIF -->

[建議] 在循環(huán)處理模板數(shù)據(jù)構(gòu)造表格時,若要求每行輸出固定的個數(shù),建議先將數(shù)據(jù)分組,之后再循環(huán)輸出,模板只是做數(shù)據(jù)展示,別加插太多業(yè)務邏輯(其他數(shù)據(jù)構(gòu)造同理)。

示例:

<!-- good -->
<table>
    <!-- BEGIN item_list -->
    <tr>
        <!-- BEGIN package_list -->
        <td>
            <span>{name}:</span><span>¥{unit_price}</span>
        </td>
        <!-- END package_list -->
    <tr>
    <!-- END item_list -->
</table>
<!-- bad -->
<table>
<tr>
    <!-- BEGIN item_list -->
    <td>
        <span>{name}:</span><span>¥{unit_price}</span>
    </td>
        <!-- IF id="5" -->
    </tr>
    <tr>
        <!-- ENDIF id -->
    <!-- END item_list -->
</tr>
</table>
<!-- good -->
<table>
    <!-- BEGIN item_list -->
    <tr>
        <!-- BEGIN package_list -->
        <td>
            <span>{name}:</span><span>¥{price}</span>
        </td>
        <!-- END package_list -->
    <tr>
    <!-- END item_list -->
</table>
<!-- bad -->
<table>
<!-- BEGIN item_list -->
<tr>
    <td>
        <span>{name}:</span>
        <!-- IF type="unit" -->
        <span>¥{unit_price}</span>
        <!-- ELSEIF type="total" -->
        <span>¥{total_price}</span>
        <!-- ENDIF type -->
    </td>
</tr>
<!-- END item_list -->
</tr>
</table>

感謝各位的閱讀!看完上述內(nèi)容,你們對HTML編碼規(guī)范是什么大概了解了嗎?希望文章內(nèi)容對大家有所幫助。如果想了解更多相關文章內(nèi)容,歡迎關注億速云行業(yè)資訊頻道。

向AI問一下細節(jié)

免責聲明:本站發(fā)布的內(nèi)容(圖片、視頻和文字)以原創(chuàng)、轉(zhuǎn)載和分享為主,文章觀點不代表本網(wǎng)站立場,如果涉及侵權請聯(lián)系站長郵箱:is@yisu.com進行舉報,并提供相關證據(jù),一經(jīng)查實,將立刻刪除涉嫌侵權內(nèi)容。

AI