HTML编码规范

　　本文档的目标是使HTML代码风格保持一致，容易被理解和被维护，如果自己没有这种习惯，请好好选择你的IDE，别再用“文本编辑器”。

　　1代码风格

　　1.1缩进与换行

　　[强制]使用4个空格做为一个缩进层级，不允许使用2个空格或tab字符。

　　示例：

　　<ul>

　　<li>first</li>

　　<li>second</li>

　　</ul>

　　[建议]每行不得超过120个字符。

　　解释：

　　过长的代码不容易阅读与维护。但是考虑到HTML的特殊性，不做硬性要求，sublime、phpstorm、wenstorm等都有标尺功能。

　　1.2命名

　　[强制]class必须单词全字母小写，单词间以-分隔。

　　[强制]class必须代表相应模块或部件的内容或功能，不得以样式信息进行命名。

　　示例：

　　[强制]元素id必须保证页面唯一。

　　解释：

　　同一个页面中，不同的元素包含相同的id，不符合id的属性含义。并且使用document.getElementById时可能导致难以追查的问题。

　　[建议]id建议单词全字母小写，单词间以-分隔。同项目必须保持风格一致。

　[建议]id、class命名，在避免冲突并描述清楚的前提下尽可能短。

　　示例：

　　<divid="nav"></div>

　　<divid="navigation"></div>

　　<p></p>

　　<p></p>

　　[强制]同一页面，应避免使用相同的name与id。

　　解释：

　　IE浏览器会混淆元素的id和name属性，document.getElementById可能获得不期望的元素。所以在对元素的id与name属性的命名需要非常小心。

　　一个比较好的实践是，为id和name使用不同的命名法。

　　示例：

　　<inputname="foo">

　　<divid="foo"></div>

　　//IE6将显示INPUT

　　alert(document.getElementById('foo').tagName);

　　</script>

　　1.3标签

　　[强制]标签名必须使用小写字母。

　　示例：

　　<p>HelloStyleGuide!</p>

　　<P>HelloStyleGuide!</P>

　　[强制]对于无需自闭合的标签，不允许自闭合。

　　解释：

　　常见无需自闭合标签有input、br、img、hr等。

　　示例：

　　<inputtype="text"name="title">

　　<inputtype="text"name="title"/>

　　[强制]对HTML5中规定允许省略的闭合标签，不允许省略闭合标签。

　　示例：

　　<ul>

　　<li>first</li>

　　<li>second</li>

　　</ul>

　　<ul>

　　<li>first

　　<li>second

　　</ul>

　　[强制]标签使用必须符合标签嵌套规则。

　　解释：

　　比如div不得置于p中，tbody必须置于table中。

　　示例：

　　<ahref=""><span></span></a>

　　<ahref="a.html"><ahref="a.html"></a></a>

　　[建议]HTML标签的使用应该遵循标签的语义。

　　解释：

　　下面是常见标签语义

　　p-段落

　　h1,h2,h3,h4,h5,h6-层级标题

　　strong,em-强调

　　ins-插入

　　del-删除

　　abbr-缩写

　　code-代码标识

　　cite-引述来源作品的标题

　　q-引用

　　blockquote-一段或长篇引用

　　ul-无序列表

　　ol-有序列表

　　dl,dt,dd-定义列表

　　示例：

　　<p>Esprimaservesasanimportant<strong>buildingblock</strong>forsomeJavaScriptlanguagetools.</p>

　　<div>Esprimaservesasanimportant<span>buildingblock</span>forsomeJavaScriptlanguagetools.</div>

　　[建议]在CSS可以实现相同需求的情况下不得使用表格进行布局。

　　解释：

　　在兼容性允许的情况下应尽量保持语义正确性。对网格对齐和拉伸性有严格要求的场景允许例外，如多列复杂表单。

　　[建议]标签的使用应尽量简洁，减少不必要的标签。

　　示例：

　　<imgsrc="image.png">

　　<span>

　　<imgsrc="image.png">

　　</span>

　　1.4属性

　　[强制]属性名必须使用小写字母。

　　示例：

　　<tablecellspacing="0">...</table>

　　<tablecellSpacing="0">...</table>

　　[强制]属性值必须用双引号包围。

　　解释：

　　不允许使用单引号，不允许不使用引号。

　　示例：

　　<scriptsrc="esl.js"></script>

　　<scriptsrc='esl.js'></script>

　　<scriptsrc=esl.js></script>

　　[建议]布尔类型的属性，建议不添加属性值。

　　示例：

　　<inputtype="text"disabled>

　　<inputtype="checkbox"value="1"checked>

　　<inputtype="text"disabled="disabled">

　　<inputtype="checkbox"value="1"checked="checked">

　　[建议]自定义属性建议以xxx-为前缀，推荐使用data-。

　　解释：

　　使用前缀有助于区分自定义属性和标准定义的属性。

　　示例：

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

　　2通用

　　2.1DOCTYPE

　　[强制]使用HTML5的doctype来启用标准模式，建议使用大写的DOCTYPE。

　　示例：

　　<!DOCTYPEhtml>

　　[建议]启用IEEdge和ChromeFrame模式。

　　示例：

　　<metahttp-equiv="X-UA-Compatible"content="IE=Edge,chrome=1">

　　[建议]在html标签上设置正确的lang属性。

　　解释：

　　有助于提高页面的可访问性，如：让语音合成工具确定其所应该采用的发音，令翻译工具确定其翻译语言等。

　　示例：

　　<html>

　　[建议]开启双核浏览器的webkit内核进行渲染。

　　解释：

　　见浏览器内核控制Meta标签说明文档一文。

　　示例：

　　<metaname="renderer"content="webkit">

　　[建议]开启浏览器的DNS预获取。

　　解释：

　　减少DNS请求次数、对DNS进行预获取。

　　示例：

　　<linkrel="dns-prefetch"href="//global.zuzuche.com/">

　　<linkrel="dns-prefetch"href="//imgcdn1.zuzuche.com/">

　　<linkrel="dns-prefetch"href="//qiniucdn.com/">

　　2.2编码

　　[强制]页面必须使用精简形式，明确指定字符编码。指定字符编码的meta必须是head的第一个直接子元素。

　　解释：

　　见HTML5Charset能用吗一文。

　　示例：

　　<html>

　　<head>

　　<metacharset="UTF-8">

　　......

　　</head>

　　<body>

　　......

　　</body>

　　</html>

　　[建议]HTML文件使用无BOM的UTF-8编码。

　　解释：

　　UTF-8编码具有更广泛的适应性。BOM在使用程序或工具处理文件时可能造成不必要的干扰。

　　2.3CSS和JavaScript引入

　　[强制]引入CSS时必须指明rel="stylesheet"。

　　示例：

　　<linkrel="stylesheet"src="page.css">

　　[建议]引入CSS和JavaScript时无须指明type属性。

　　解释：

　　text/css和text/javascript是type的默认值。

　　[建议]展现定义放置于外部CSS中，行为定义放置于外部JavaScript中。

　　解释：

　　结构-样式-行为的代码分离，对于提高代码的可阅读性和维护性都有好处。

　　[建议]在head中引入页面需要的所有CSS资源。

　　解释：

　　在页面渲染的过程中，新的CSS可能导致元素的样式重新计算和绘制，页面闪烁。

　　[建议]JavaScript应当放在页面末尾，或采用异步加载。

　　解释：

　　将script放在页面中间将阻断页面的渲染。出于性能方面的考虑，如非必要，请遵守此条建议。

　　示例：

　　<body>

　　<scriptsrc="init-behavior.js"></script>

　　</body>

　　[强制]引用静态资源的URL协议部分与页面相同，建议省略协议前缀。

　　示例：

　　<scriptsrc="//global.zuzuche.com/assets/js/gallery/jquery/1.11.2/jquery.js"></script>

　　3Head

　　3.1title

　　[强制]页面必须包含title标签声明标题。

　　[强制]title必须作为head的直接子元素，并紧随<linkrel="dns-prefetch">声明之后。

　　解释：

　　title中如果包含ascii之外的字符，浏览器需要知道字符编码类型才能进行解码，否则可能导致乱码。

　　示例：

　　<head>

　　<metacharset="UTF-8">

　　<linkrel="dns-prefetch"href="//global.zuzuche.com/">

　　<linkrel="dns-prefetch"href="//imgcdn1.zuzuche.com/">

　　<linkrel="dns-prefetch"href="//qiniucdn.com/">

　　</head>

　　4图片

　　[强制]禁止img的src取值为空。延迟加载的图片也要增加默认的src。

　　解释：

　　src取值为空，会导致部分浏览器重新加载一次当前页面，参考：

　　https://developer.yahoo.com/performance/rules.html#emptysrc

　　[建议]避免为img添加不必要的title属性。

　　解释：

　　多余的title影响看图体验，并且增加了页面尺寸。

　　[建议]为重要图片添加alt属性。

　　解释：

　　可以提高图片加载失败时的用户体验。

　　[建议]添加width和height属性，以避免页面抖动。

　　[建议]有下载需求的图片采用img标签实现，无下载需求的图片采用CSS背景图实现。

　　解释：

　　产品logo、用户头像、用户产生的图片等有潜在下载需求的图片，以img形式实现，能方便用户下载。

　　无下载需求的图片，比如：icon、背景、代码使用的图片等，尽可能采用css背景图实现。

　　5表单

　　5.1控件标题

　　[强制]有文本标题的控件必须使用label标签将其与其标题相关联。

　　解释：

　　有两种方式：

　　将控件置于label内。

　　label的for属性指向控件的id。

　　推荐使用第一种，减少不必要的id。如果DOM结构不允许直接嵌套，则应使用第二种。

　　示例：

　　<label><inputtype="checkbox"name="confirm"value="on">我已确认上述条款</label>

　　<labelfor="username">用户名：</label><inputtype="textbox"name="username"id="username">

　　5.2按钮

　　[强制]使用button元素时必须指明type属性值。

　　解释：

　　button元素的默认type为submit，如果被置于form元素中，点击后将导致表单提交。为显示区分其作用方便理解，必须给出type属性。

　　示例：

　　<buttontype="submit">提交</button>

　　<buttontype="button">取消</button>

　　[建议]尽量不要使用按钮类元素的name属性。

　　解释：

　　由于浏览器兼容性问题，使用按钮的name属性会带来许多难以发现的问题。具体情况可参考此文。

　　5.3可访问性(A11Y)

　　[建议]负责主要功能的按钮在DOM中的顺序应靠前。

　　解释：

　　负责主要功能的按钮应相对靠前，以提高可访问性。如果在CSS中指定了float:right则可能导致视觉上主按钮在前，而DOM中主按钮靠后的情况。

　　示例：

　　<style>

　　.buttons.button-group{

　　float:right;

　　}

　　</style>

　　<div>

　　<buttontype="submit">提交</button>

　　<buttontype="button">取消</button>

　　</div>

　　<style>

　　.buttonsbutton{

　　float:right;

　　}

　　</style>

　　<div>

　　<buttontype="button">取消</button>

　　<buttontype="submit">提交</button>

　　</div>

　　[建议]当使用JavaScript进行表单提交时，如果条件允许，应使原生提交功能正常工作。

　　解释：

　　当浏览器JS运行错误或关闭JS时，提交功能将无法工作。如果正确指定了form元素的action属性和表单控件的name属性时，提交仍可继续进行。

　　示例：

　　<formaction="/login"method="post">

　　</form>

　　[建议]在针对移动设备开发的页面时，根据内容类型指定输入框的type属性。

　　解释：

　　根据内容类型指定输入框类型，能获得能友好的输入体验。

　　示例：

　　<inputtype="date">

　　<inputtype="tel">

　　<inputtype="number">

　　<inputtype="number"pattern="\d*">

　　6模板中的HTML

　　[建议]模板代码的缩进优先保证HTML代码的缩进规则。

　　示例：

　　<div>

　　<ul>

　　</ul>

　　</div>

　　<div>

　　<ul>

　　</ul>

　　</div>

　　[建议]模板代码应以保证HTML单个标签语法的正确性为基本原则。

　　示例：

<liclass="selected">{type_name}</li>

<li>{type_name}</li>

　　[建议]模板代码应以保证结束符的闭合名

　　示例：

　　<div>

　　<ul>

　　<li>

　　<span>{name}：</span><span>￥{unit_price}</span>

　　<li>

　　</ul>

　　</div>

　　<div>

　　<ul>

　　<li>

　　<span>{name}：</span><span>￥{unit_price}</span>

　　<li>

　　</ul>

　　</div>

　　[建议]在循环处理模板数据构造表格时，若要求每行输出固定的个数，建议先将数据分组，之后再循环输出，模板只是做数据展示，别加插太多业务逻辑（其他数据构造同理）。

　　示例：

　　<table>

　　<tr>

　　<td>

　　<span>{name}：</span><span>￥{unit_price}</span>

　　</td>

　　<tr>

　　</table>

　　<table>

　　<tr>

　　<td>

　　<span>{name}：</span><span>￥{unit_price}</span>

　　</td>

　　</tr>

　　<tr>

　　</tr>

　　</table>

　　<table>

　　<tr>

　　<td>

　　<span>{name}：</span><span>￥{price}</span>

　　</td>

　　<tr>

　　</table>

　　<table>

　　<tr>

　　<td>

　　<span>￥{unit_price}</span>

　　<span>￥{total_price}</span>

　　</td>

　　</tr>

　　</tr>

　　</table>

如需转载，请注明文章出处和来源网址：http://www.divcss5.com/html/h53928.shtml