目录1. 前言2. 通用 2.1. DOCTYPE 2.2. 字符编码 2.3. 引入 CSS 和 JavaScript 文件 2.4. head 2.4.1 title 2.4.2 favicon3. 代码风格 3.1. 缩进与换行 3.2. 命名 3.3. 标签 3.4. 属性4. 图片5. 表单 5.1. 控件标题 5.2. 按钮
1. 前言
本文档的目标是使HTML代码风格保持一致,容易被理解和被维护
2. 通用2.1. DOCTYPE
[强制] 使用 HTML5 的 doctype 来启用标准模式。
为每个 HTML 页面的第一行添加 standards mode(标准模式) 声明,这样能够确保在每个浏览器中拥有一致的展现。
示例:
html>
[建议] 启用 IE Edge 模式。
IE 支持通过特定的 标签来确定绘制当前页面所应该采用的 IE 版本。除非有强烈的特殊需求,否则最好是设置为 edge mode,从而通知 IE 采用其所支持的最新的绘制模式。
示例:
[建议] 在 html 标签上设置正确的 lang 属性。
强烈建议为 html 根元素指定 lang 属性,从而为文档设置正确的语言。这将有助于语音合成工具确定其所应该采用的发音,有助于翻译工具确定其翻译时所应遵守的规则等等。
示例:
2.2. 字符编码
[强制] 页面必须使用精简形式,明确指定字符编码。
通过明确声明字符编码,能够确保浏览器快速并容易的判断页面内容的渲染方式。这样做的好处是,可以避免在 HTML 中使用字符实体标记(character entity),从而全部与文档编码一致(一般采用 UTF-8 编码)。
示例:
...... ......
[建议] HTML 文件使用无 BOM 的 UTF-8 编码。
UTF-8 编码具有更广泛的适应性。BOM 在使用程序或工具处理文件时可能造成不必要的干扰。
2.3. 引入 CSS 和 JavaScript 文件
[强制] 引入 CSS 时必须指明 rel="stylesheet"。
示例:
<link rel="stylesheet" src="page.css">
[建议] 引入 CSS 和 JavaScript 时无须指明 type 属性。
根据 HTML5 规范,在引入 CSS 和 JavaScript 文件时一般不需要指定 type 属性,因为 text/css 和 text/javascript 分别是它们的默认值。示例:
<link rel="stylesheet" href="code-guide.css"><style> /* ... */style><script src="code-guide.js">script>
[建议] 展现定义放置于外部 CSS 中,行为定义放置于外部 JavaScript 中。
结构-样式-行为的代码分离,对于提高代码的可阅读性和维护性都有好处。
[建议] 在 head 中引入页面需要的所有 CSS 资源。
在页面渲染的过程中,新的CSS可能导致元素的样式重新计算和绘制,页面闪烁。
[建议] JavaScript 应当放在页面末尾,或采用异步加载。
将 script 放在页面中间将阻断页面的渲染。出于性能方面的考虑,如非必要,请遵守此条建议。
示例:
2.4. head
2.4.1 title
[强制] 页面必须包含 title 标签声明标题。
[强制] title 必须作为 head 的直接子元素,并紧随 charset 声明之后。
示例:
页面标题
2.4.2 favicon
[强制] 保证 favicon 可访问。
在未指定 favicon 时,大多数浏览器会请求 Web Server 根目录下的 favicon.ico 。为了保证 favicon 可访问,避免404,必须遵循以下两种方法之一:
在 Web Server 根目录放置 favicon.ico 文件。
使用 link 指定 favicon。
示例:
3. 代码风格
3.1. 缩进与换行
[强制] 使用 4 个空格做为一个缩进层级,不允许使用 2 个空格 或 tab 字符。
示例:
first second
3.2. 命名
[强制] class 必须单词全字母小写,单词间以 - 分隔。
[强制] class 必须代表相应模块或部件的内容或功能,不得以样式信息进行命名。
[强制] 元素 id 必须保证页面唯一。
[建议] id 建议单词全字母小写,单词间以 - 分隔。同项目必须保持风格一致。
[强制] 同一页面,应避免使用相同的 name 与 id。
IE 浏览器会混淆元素的 id 和 name 属性, document.getElementById 可能获得不期望的元素。所以在对元素的 id 与 name 属性的命名需要非常小心。
示例:
3.3. 标签
[强制] 标签名必须使用小写字母。
示例:
Hello StyleGuide!
Hello StyleGuide!
[强制] 对于无需自闭合的标签,不允许自闭合。
示例:
[强制] 对 HTML5 中规定允许省略的闭合标签,不允许省略闭合标签。
示例:
first second first second
[强制] 标签使用必须符合标签嵌套规则。
例如:div 不得置于 p 中,tbody 必须置于 table 中
参考:http://jkorpela.fi/html5.dtd
[建议] HTML 标签的使用应该遵循标签的语义
示例:
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 可以实现相同需求的情况下不得使用表格进行布局。
[建议] 标签的使用应尽量简洁,减少不必要的标签。
示例:
3.4. 属性
[强制] 属性名必须使用小写字母。
示例:
...
...
[强制] 属性值必须用双引号包围。
不允许使用单引号,不允许不使用引号。
示例:
<script src="esl.js">script><script src='esl.js'>script><script src=esl.js>script>
[建议] 布尔类型的属性,建议不添加属性值。
示例:
<input type="text" disabled><input type="checkbox" value="1" checked><select> <option value="1" selected>1option>select>
[建议] 自定义属性建议以 xxx- 为前缀,推荐使用 data-。
示例:
[建议] HTML 属性应当按照以下给出的顺序依次排列,确保代码的易读性。
class
id, name
data-*
src, for, type, href, value
title, alt
role, aria-*
class 用于标识高度可复用组件,因此应该排在首位。id 用于标识具体组件,应当谨慎使用(例如,页面内的书签),因此排在第二位。
示例:
class= Example linkclass="..." alt=
4. 图片
[强制] 禁止 img 的 src 取值为空。延迟加载的图片也要增加默认的 src。
src 取值为空,会导致部分浏览器重新加载一次当前页面。
[建议] 避免为 img 添加不必要的 title 属性。
多余的 title 影响看图体验,并且增加了页面尺寸。
[建议] 为重要图片添加 alt 属性。
可以提高图片加载失败时的用户体验
[建议] 添加 width 和 height 属性,以避免页面抖动。
[建议] 有下载需求的图片采用 img 标签实现,无下载需求的图片采用 CSS 背景图实现。
产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片,以 img 形式实现,能方便用户下载。
无下载需求的图片,比如:icon、背景、代码使用的图片等,尽可能采用 css 背景图实现。
5.1. 控件标题
[强制] 有文本标题的控件必须使用 label 标签将其与其标题相关联。
有两种方式:
将控件置于 label 内。
label 的 for 属性指向控件的 id。
示例:
我已确认上述条款用户名:
5.2. 按钮
[强制] 使用 button 元素时必须指明 type 属性值。
button 元素的默认 type 为 submit,如果被置于 form 元素中,点击后将导致表单提交。为显示区分其作用方便理解,必须给出 type 属性。
示例:
提交取消button>
参考资料:
百度规范:
https://github.com/fex-team/styleguide/blob/master/html.md
BootStrap规范:
https://codeguide.bootcss.com/#html
Best Practices for Speeding Up Your Web Site——Avoid Empty Image src:
https://developer.yahoo.com/performance/rules.html?guccounter=1&guce_referrer=aHR0cHM6Ly9naXRodWIuY29tL2ZleC10ZWFtL3N0eWxlZ3VpZGUvYmxvYi9tYXN0ZXIvaHRtbC5tZA&guce_referrer_sig=AQAAAL4m2IAb3Y6hgGUu7H_YsODpWsfws32Mz9CvXwKBHH2DGmiCX5OFzMR0bLT9DPUHH7UHBp9I1A7iZdftUGZ2TRvz9gsCitFq2AF4t_pGqpl7PyeJYjdgP97vW2TisZeZjsWLgS0Pyl4SWx0gjgj0b0h2zOqPEKhqcfdNSB1KwkRW#emptysrc