HTML代码规范
语言规范
doctype声明使用html5。<!doctype html>
统一页面编码格式为
utf-8,meta标签charset设置为utf-8;<meta charset="utf-8" />
标签、标签属性全部小写。
(√)
<a href="/" data-attr="attr">Home</a>
(╳)
<A HREF="/" attr="attr">Home</A>
所有html标签必须有结束符,
<img />,<col />,<base />,<link />,<meta />,<input />除外。标签自定义属性使用
data-name="value"的形式来写, 如果自定义属性特别多, 可以考虑使用标准 json 的方式去写:data-json='{"a":"a", "b":"b"}'。(√)
<div data-json='{"a":1, "b":true, "c":[1, 2]}' ></div>
(╳)
<div data-json="{a:1, b:true, c:[1, 2]}" ></div><!--对于这样的写法,直接JSON.parse会出错-->
对于 JS 钩子, 以
jCamelCase的驼峰形式来命名。对于普通
class或者id命名(此处id仅做样式,不做js钩子), 统一使用小写字母, 第一个字符必须为字母, 连接符用中划线-。(√)
<div class="sns-box"></div><div class="box"></div>
(╳)
<div class="Sns-box"></div><div class="snsBox"></div><div class="Box"></div>
css 引用置于头部
<head>标签内。js 引用置于底部
</body>标签前。
标签使用
<base>标签必须放在<head>内。<strong>标签用于强调重要性,<em>标签用于表示内容的着重点。参考当
link元素用于引用CSS文档时, 默认media是screen, 如为特殊终端提供样式, 请指定media属性, 如media=“print”;img标签必须加alt,尤其是logo、商品图片等关键图片信息,对SEO友好。
注释规范
主要的
html模块需加注释修改别人代码时, 加入修改信息。至少加入修改者大名和修改时间。
<!--主要修改IE8浏览器兼容性问题 djune 2013-09-26 13:21 -->
其他注意
开发时页面原则上不内嵌
style、script代码,如特殊情况请标明并注释。缩进以4个空格为基本单位,为每个块级元素或表格元素标签新起一行,并且对每个子元素进行缩进。参考
