Skip to content

Latest commit

 

History

History
96 lines (59 loc) · 2.54 KB

html.md

File metadata and controls

96 lines (59 loc) · 2.54 KB

HTML代码规范

语言规范

  1. doctype声明使用html5
```html
<!doctype html>
```
  1. 统一页面编码格式为utf-8 , meta标签charset设置为utf-8;
```html
<meta charset="utf-8" />
```
  1. 标签、标签属性全部小写。
**(√)**

```html
<a href="/" data-attr="attr">Home</a>

```

**(╳)**

```html
<A HREF="/" attr="attr">Home</A>
```
  1. 所有html标签必须有结束符,<img />, <col />, <base />, <link />, <meta />, <input /> 除外。

  2. 标签自定义属性使用data-name="value"的形式来写, 如果自定义属性特别多, 可以考虑使用标准 json 的方式去写: data-json='{"a":"a", "b":"b"}'

**(√)**

```html
<div data-json='{"a":1, "b":true, "c":[1, 2]}' ></div>
```

**(╳)**

```html
<div data-json="{a:1, b:true, c:[1, 2]}" ></div>
<!--对于这样的写法,直接JSON.parse会出错-->
```
  1. 对于 JS 钩子, 以 jCamelCase 的驼峰形式来命名。

  2. 对于普通class或者id命名(此处id仅做样式,不做js钩子), 统一使用小写字母, 第一个字符必须为字母, 连接符用中划线 -

**(√)**

```html
<div class="sns-box"></div>
<div class="box"></div>
```

**(╳)**

```html
<div class="Sns-box"></div>  
<div class="snsBox"></div>  
<div class="Box"></div>
```
  1. css 引用置于头部<head>标签内。

  2. js 引用置于底部</body>标签前。

标签使用

  1. <base>标签必须放在<head>内。

  2. <strong>标签用于强调重要性, <em>标签用于表示内容的着重点。参考

  3. link元素用于引用CSS文档时, 默认mediascreen, 如为特殊终端提供样式, 请指定media属性, 如media=“print”;

  4. img标签必须加alt,尤其是logo、商品图片等关键图片信息,对SEO友好。

注释规范

  1. 主要的html模块需加注释

  2. 修改别人代码时, 加入修改信息。至少加入修改者大名和修改时间。

```html
<!--主要修改IE8浏览器兼容性问题 djune 2013-09-26 13:21 -->
```

其他注意

  1. 开发时页面原则上不内嵌stylescript代码,如特殊情况请标明并注释。

  2. 缩进以4个空格为基本单位,为每个块级元素或表格元素标签新起一行,并且对每个子元素进行缩进。参考