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