HTML編寫規範

時間 2019-11-17

標籤 html 編寫規範欄目 HTML 简体版

原文原文鏈接

一、代碼風格

1.1 縮進與換行`與css同樣`

1.2 命名

class必須單詞所有字母小寫，單詞間以-分隔
class必須表明相應模塊或部件的內容或功能，不得以樣式信息進行命名

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

<!-- bad -->
<div class="left"></div>
複製代碼

元素ID必須保證頁面惟一同一個頁面中，不一樣的元素包含相同的 id，不符合 id 的屬性含義。而且使用 document.getElementById 時可能致使難以追查的問題。
ID必須使用駝峯命名法
ID，class命名，在避免衝突並描述清楚的前提下儘量短

<!-- good -->
<p class="comment"></p>
<!-- bad -->
<p class="com"></p>

<!-- good -->
<span class="author"></span>
<!-- bad -->
<span class="red"></span>
複製代碼

同一頁面，應避免使用相同的name與ID

IE 瀏覽器會混淆元素的 id 和 name 屬性， document.getElementById 可能得到不指望的元素。因此在對元素的 id 與 name 屬性的命名須要很是當心。css

<input name="foo">
<div id="foo"></div>
<script>
// IE6 將顯示 INPUT
alert(document.getElementById('foo').tagName);
</script>
複製代碼

1.3 標籤

標籤名必須使用小寫字母html

<p>Hello world!</p>
複製代碼

對於無需自閉和的標籤，不容許自閉和jquery

常見無需自閉和的標籤有input、br、img、等編程

<input type="text" name="title">
複製代碼

除HTML5 中規定容許省略的閉合標籤外，其餘不容許省略閉合標籤。（對代碼體積要求很是嚴苛的場景，能夠例外）瀏覽器

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

<!-- bad -->
<ul>
    <li>first
    <li>second
</ul>
複製代碼

標籤使用必須符合標籤嵌套規則bash

好比：div不得置於p中，tbody必須置於table中異步

在css能夠實現相同需求的狀況下不得使用表格進行佈局ide

在兼容性容許的狀況下應儘可能保持語義正確性。對網格對齊和拉伸性有嚴格要求的場景容許例外，如多列複雜表單。工具

標籤的使用應儘可能簡潔，減小沒必要要的標籤佈局

<!-- good -->
<img class="avatar" src="image.png">

<!-- bad -->
<span class="avatar">
    <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>
複製代碼

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

<input type="text" disabled>
<input type="checkbox" value="1" checked>
複製代碼

自定義屬性推薦使用data-

使用前綴有助於區分自定義屬性和標準定義的屬性

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

1.5 語義化

咱們一直都在說語義化編程，語義化編程，可是在代碼中不多有人徹底使用正確的元素。使用語義化標籤也是有理由SEO的。

語義化是指：根據元素其被創造出來時的初始意義來使用它。意思就是用正確的標籤幹正確的事，而不是隻有div和span。

二、通用

2.1 DOCTYPE

使用 HTML5 的 doctype 來啓用標準模式，建議使用大寫的 DOCTYPE。

<!DOCTYPE html>
複製代碼

建議在html標籤上設置正確的lang屬性

有助於提升頁面的可訪問性，如：讓語音合成工具肯定其所應該採用的發音，令翻譯工具肯定其翻譯語言等。

<html lang="zh-CN">
複製代碼

2.2 `CSS`和`js`引入

引入css時必須指明rel="stylesheet"
引入css和js時無須指明type屬性
樣式放置於外部css中，功能放置於外部js中

結構-樣式-行爲的代碼分離，對於提升代碼的可閱讀性和維護性都有好處。一、不使用超過一到兩張樣式表二、不使用超過一到兩個腳本（學會用合併腳本）三、不使用行內樣式（<style>.no-good {}</style>） 四、不在元素上使用 style 屬性（<hr style="border-top: 5px solid black">） 五、不使用行內腳本（<script>alert('no good')</script>） 六、不使用表象元素（i.e. <b>, <u>, <center>, <font>, <b>） 七、不使用表象 class 名（i.e. red, left, center）

在head中引入頁面須要的全部css資源

在頁面渲染的過程當中，新的CSS可能致使元素的樣式從新計算和繪製，頁面閃爍。

js應當放在頁面的末尾，或採用異步加載
移動環境或只針對現代瀏覽器設計的 Web 應用，若是引用外部資源的 URL 協議部分與頁面相同，建議省略協議前綴。

<script src="//s1.bdstatic.com/cache/static/jquery-1.10.2.min_f2fb5194.js"></script>
複製代碼

圖片和 SVG 圖形能被引入到 HTML 中的惟一理由是它們呈現出了與內容相關的一些信息。

三、head

3.1 title

頁面必須包含title標籤聲明標題
title必須做爲head的直接子元素，並緊隨charset聲明以後

3.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">
複製代碼

3.3 viewport

若頁面須要在移動設備上使用，需設置viewport

<meta name="viewport"
          content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
複製代碼

四、圖片

禁止img的src取值爲空，延遲加載的圖片也要增長默認的src

src 取值爲空，會致使部分瀏覽器從新加載一次當前頁面

避免爲img添加沒必要要的title屬性

多餘的title影響看圖體驗，而且增長了頁面尺寸

爲重要圖片添加alt屬性。

能夠提升圖片加載失敗時的用戶體驗

添加width和height屬性，以免頁面抖動有下載需求的圖片採用 img 標籤實現，無下載需求的圖片採用CSS 雪碧圖實現。

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

四、表單

4.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">
複製代碼

4.2 按鈕

使用button元素時必須指明type屬性值 button 元素的默認 type 爲 submit，若是被置於 form 元素中，點擊後將致使表單提交。爲顯示區分其做用方便理解，必須給出 type 屬性。

<button type="submit">提交</button>
<button type="button">取消</button>
複製代碼

儘可能不要使用按鈕類元素的name屬性因爲瀏覽器兼容性問題，使用按鈕的name屬性會帶來許多難以發現的問題，具體狀況可參照http://w3help.org/zh-cn/causes/CM2001

4.3 可訪問性

負責主要功能的按鈕在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>
複製代碼