前言:
代码规范有助于减少团队(个人)的维护成本和方便日后的自动化改进
尽量遵循html标准和语义,但不要以牺牲实用性为代价,任何时候都要尽量使用少的标签并保持最小的复杂度
一、语法
- 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法。
- 嵌套元素应当缩进一次(即两个空格)。
- 对于属性的定义,确保全部使用双引号,绝不要使用单引号。
- 不要在自闭合(self-closing)元素的尾部添加斜线 -- HTML5 规范中明确说明这是可选的。
- 不要省略可选的结束标签(closing tag)(例如,
</li>
或</body>
)。
HTML5doctype
为每个 HTML 页面的第一行添加标准模式(standard mode)的声明,这样能够确保在每个浏览器中拥有一致的展现。
三、语言属性
语言属性:
强烈建议为 html 根元素指定 lang 属性,从而为文档设置正确的语言。这将有助于语音合成工具确定其所应该采用的发音,有助于翻译工具确定其翻译时所应遵守的规则等等。
四、IE 兼容模式
IE兼容模式
IE 支持通过特定的 <meta>
标签来确定绘制当前页面所应该采用的 IE 版本。除非有强烈的特殊需求,否则最好是设置为 edge mode,从而通知 IE 采用其所支持的最新的模式。
<meta http-equiv = "X-UA-Compatible" content = "IE-Edge">
五、字符编码
字符编码
通过明确声明字符编码,能够确保浏览器快速并容易的判断页面内容的渲染方式。这样做的好处是,可以避免在HTML 中使用字符实体标记(characterentity),
从而全部与文档编码一致(一般采用UTF-8 编码)。
<head>
<meta charset = "UTF-8">
</head>
六、引入css文件和JavaScript文件
引入css文件和JavaScript文件
根据 HTML5 规范,在引入 CSS 和 JavaScript 文件时一般不需要指定 type
属性,因为 text/css
和 text/javascript
分别是它们的默认值
七、属性顺序
属性顺序
HTML 属性应当按照以下给出的顺序依次排列,确保代码的易读性。
class
id
,name
data-*
src
,for
,type
,href
,value
title
,alt
role
,aria-*
class 用于标识高度可复用组件,因此应该排在首位。id 用于标识具体组件,应当谨慎使用(例如,页面内的书签),因此排在第二位。
<a class="" id="" data-toggle="model" href=""></a>
<input class="form-control" type="text">
<img src="" alt="">
八、布尔型属性
布尔型属性
布尔型属性可以在声明时不赋值,XHTML 规范要求为其赋值,但是HTML5规范不需要
元素的布尔值属性如果有值,就是true 如果没有值,就是false
九、减少没必要的标签
减少标签的数量
编写html代码时,尽量避免多余的父元素,很多时候,这需要迭代和重构来实现
例如:
<!--not so great-->
<span class="avatar">
<img src="">
</span>
<!--better-->
<img class="avatar" src="">