HTML代碼書寫規(guī)范指南

字號:


    通用約定
    標(biāo)簽
    自閉合(self-closing)標(biāo)簽,無需閉合 ( 例如: img input br hr 等 );
    可選的閉合標(biāo)簽(closing tag),需閉合 ( 例如:</li> 或 </body>);
    盡量減少標(biāo)簽數(shù)量;
    XML/HTML Code
    1.<img src="images/google.png">  
    2.<input type="text" name="title">  
    3.  
    4.<ul>  
    5.  <li>Style</li>  
    6.  <li>Guide</li>  
    7.</ul>  
    8.  
    9.<!-- Not recommended -->  
    10.<span>  
    11.  <img src="...">  
    12.</span>  
    13.  
    14.<!-- Recommended -->  
    15.<img src="...">  
    Class 與 ID
    class 應(yīng)以功能或內(nèi)容命名,不以表現(xiàn)形式命名;
    class 與 id 單詞字母小寫,多個單詞組成時,采用中劃線-分隔;
    使用唯一的 id 作為 Javascript hook,同時避免創(chuàng)建無樣式信息的 class;
    XML/HTML Code
    1.<!-- Not recommended -->  
    2.<div></div>  
    3.  
    4.<!-- Recommended -->  
    5.<div id="j-hook"></div>  
    屬性順序
    HTML 屬性應(yīng)該按照特定的順序出現(xiàn)以保證易讀性。
    id
    class
    name
    data-xxx
    src, for, type, href
    title, alt
    aria-xxx, role
    XML/HTML Code
    1.<a id="..." data-modal="toggle" href="###"></a>  
    2.  
    3.<input type="text">  
    4.  
    5.<img src="...">  
    引號
    屬性的定義,統(tǒng)一使用雙引號。
    XML/HTML Code
    1.<!-- Not recommended -->  
    2.<span id='j-hook' class=text>Google</span>  
    3.  
    4.<!-- Recommended -->  
    5.<span id="j-hook">Google</span>  
    b嵌套
    a 不允許嵌套 div 這種約束屬于語義嵌套約束,與之區(qū)別的約束還有嚴(yán)格嵌套約束,比如 a 不允許嵌套 a。
    嚴(yán)格嵌套約束在所有的瀏覽器下都不被允許;而語義嵌套約束,瀏覽器大多會容錯處理,生成的文檔樹可能相互不太一樣。
    語義嵌套約束
    <li> 用于 <ul> 或 <ol> 下;
    <dd>,<dt> 用于 <dl> 下;
    <thead>,<tbody>,<tfoot>,<tr>,<td> 用于<table>下;
    嚴(yán)格嵌套約束
    inline-Level 元素,僅可以包含文本或其它 inline-Level 元素;
    <a> 里不可以嵌套交互式元素 <a>、<button>、<select>等;
    <p>里不可以嵌套塊級元素<div>、<h1>~<h6>、<p>、<ul>/<ol>/<li>、<dl>/<dt>/<dd>、<form>等。
    布爾值屬性
    HTML5 規(guī)范中 disabled、checked、selected 等屬性不用設(shè)置值。
    XML/HTML Code
    1.<input type="text" disabled>  
    2.  
    3.<input type="checkbox" value="1" checked>  
    4.  
    5.<select>  
    6.  <option value="1" selected>1</option>  
    7.</select>  
    語義化
    沒有 CSS 的 HTML 是一個語義系統(tǒng)而不是 UI 系統(tǒng)。
    通常情況下,每個標(biāo)簽都是有語義的,所謂語義就是你的衣服分為外套, 褲子,裙子,內(nèi)褲等,各自有對應(yīng)的功能和含義。所以你總不能把內(nèi)褲套在脖子上吧。-- 一絲
    此外語義化的 HTML 結(jié)構(gòu),有助于機(jī)器(搜索引擎)理解,另一方面多人協(xié)作時,能迅速了解開發(fā)者意圖。
    常見標(biāo)簽語義
    名單
    示例 
    將你構(gòu)建的頁面當(dāng)作一本書,將標(biāo)簽的語義對應(yīng)的其功能和含義;
    書的名稱:<h1>
    書的每個章節(jié)標(biāo)題: <h2>
    章節(jié)內(nèi)的文章標(biāo)題: <h3>
    小標(biāo)題 / 副標(biāo)題: <h4> <h5> <h6>
    章節(jié)的段落: <p>
    HEAD
    文檔類型
    為每個 HTML 頁面的第一行添加標(biāo)準(zhǔn)模式(standard mode)的聲明, 這樣能夠確保在每個瀏覽器中擁有一致的表現(xiàn)。
    XML/HTML Code
    1.<!DOCTYPE html>  
    2.語言屬性   
    3.  
    4.<!-- 中文 -->  
    5.<html lang="zh-Hans">  
    6.  
    7.<!-- 簡體中文 -->  
    8.<html lang="zh-cmn-Hans">  
    9.  
    10.<!-- 繁體中文 -->  
    11.<html lang="zh-cmn-Hant">  
    12.  
    13.<!-- English -->  
    14.<html lang="en">  
    字符編碼
    以無 BOM 的 utf-8 編碼作為文件格式;
    指定字符編碼的 meta 必須是 head 的第一個直接子元素
    XML/HTML Code
    1.<html>  
    2.  <head>  
    3.    <meta charset="utf-8">  
    4.    ......   
    5.  </head>  
    6.  <body>  
    7.    ......   
    8.  </body>  
    9.</html>  
    IE 兼容模式
    優(yōu)先使用最新版本的 IE 和 Chrome 內(nèi)核。
    XML/HTML Code1.<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">  
    SEO 優(yōu)化
    XML/HTML Code
    1.<head>  
    2.    <meta charset="utf-8">  
    3.    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">  
    4.    <!-- SEO -->  
    5.    <title>Style Guide</title>  
    6.    <meta name="keywords" content="your keywords">  
    7.    <meta name="description" content="your description">  
    8.    <meta name="author" content="author,email address">  
    9.</head>  
    viewport
    viewport: 一般指的是瀏覽器窗口內(nèi)容區(qū)的大小,不包含工具條、選項卡等內(nèi)容;
    width: 瀏覽器寬度,輸出設(shè)備中的頁面可見區(qū)域?qū)挾龋?BR>    device-width: 設(shè)備分辨率寬度,輸出設(shè)備的屏幕可見寬度;
    initial-scale: 初始縮放比例;
    maximum-scale: 最大縮放比例;
    為移動端設(shè)備優(yōu)化,設(shè)置可見區(qū)域的寬度和初始縮放比例。
    XML/HTML Code1.<meta name="viewport" content="width=device-width, initial-scale=1.0">  
    iOS 圖標(biāo)
    apple-touch-icon 圖片自動處理成圓角和高光等效果;
    apple-touch-icon-precomposed 禁止系統(tǒng)自動添加效果,直接顯示設(shè)計原圖;
    XML/HTML Code
    1.<!-- iPhone 和 iTouch,默認(rèn) 57x57 像素,必須有 -->  
    2.<link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-57x57-precomposed.png">  
    3.  
    4.<!-- iPad,72x72 像素,可以沒有,但推薦有 -->  
    5.<link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-72x72-precomposed.png" sizes="72x72">  
    6.  
    7.<!-- Retina iPhone 和 Retina iTouch,114x114 像素,可以沒有,但推薦有 -->  
    8.<link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-114x114-precomposed.png" sizes="114x114">  
    9.  
    10.<!-- Retina iPad,144x144 像素,可以沒有,但推薦有 -->  
    11.<link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-144x144-precomposed.png" sizes="144x144">  
    favicon
    在未指定 favicon 時,大多數(shù)瀏覽器會請求 Web Server 根目錄下的 favicon.ico。為了保證 favicon 可訪問,避免 404,必須遵循以下兩種方法之一:
    在 Web Server 根目錄放置 favicon.ico 文件;
    使用 link 指定 favicon;
    XML/HTML Code1.<link rel="shortcut icon" href="path/to/favicon.ico">  
    HEAD 模板
    XML/HTML Code
    1.<!DOCTYPE html>  
    2.<html lang="zh-cmn-Hans">  
    3.<head>  
    4.    <meta charset="utf-8">  
    5.    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">  
    6.    <title>Style Guide</title>  
    7.    <meta name="description" content="不超過150個字符">  
    8.    <meta name="keywords" content="">  
    9.    <meta name="author" content="name, email@gmail.com">  
    10.  
    11.    <!-- 為移動設(shè)備添加 viewport -->  
    12.    <meta name="viewport" content="width=device-width, initial-scale=1.0">  
    13.  
    14.    <!-- iOS 圖標(biāo) -->  
    15.    <link rel="apple-touch-icon-precomposed" href="/apple-touch-icon-57x57-precomposed.png">  
    16.  
    17.    <link rel="alternate" type="application/rss+xml" href="/rss.xml" />  
    18.    <link rel="shortcut icon" href="path/to/favicon.ico">  
    19.</head>  
    HTML 注釋
    模塊注釋
    XML/HTML Code
    1.<!-- 文章列表列表模塊 -->  
    2.<div>  
    3....   
    4.</div>  
    5.區(qū)塊注釋   
    6.<!--   
    7.@name: Drop Down Menu   
    8.@description: Style of top bar drop down menu.   
    9.@author: Ashu(Aaaaaashu@gmail.com)   
    10.-->