HTML开发规范

# HTML开发规范

# 简介

HTML作为描述网页结构的超文本标记语言，有着广泛的应用。本文档的目标是使HTML代码风格保持一致，容易被理解和被维护。

# 内容格式与编码规范

严格依照《内容格式与编码规范》。

# 缩进

[RECOMMENDED] 使用2个空格作为一个缩进层级。

备注：对于script或style等标签内容中的缩进保持一致。

示例：

<style>
  ul {
    padding: 0;
  }
</style>
<ul>
  <li>first</li>
  <li>second</li>
</ul>
<script>
  require(["app"], function (app) {
    app.init();
  });
</script>

1
2
3
4
5
6
7
8
9
10
11
12
13
14

# 换行

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

解释：过长的代码不容易阅读与维护。但是考虑到HTML的特殊性，不做硬性要求。

# 命名

[MUST] class必须单词全字母小写，单词间以连字符或下划线分隔。推荐使用连字符。

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

示例：

<!-- 推荐 -->
<div class="sidebar"></div>

<!-- 不推荐 -->
<div class="left"></div>

1
2
3
4
5

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

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

[MUST] id单词全字母小写，单词间以连字符或下划线分隔。推荐使用连字符。同项目必须保持风格一致。

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

示例：

<!-- 推荐 -->
<div id="nav"></div>
<!-- 不推荐 -->
<div id="navigation"></div>

<!-- 推荐 -->
<p class="comment"></p>
<!-- 不推荐 -->
<p class="com"></p>

<!-- 推荐 -->
<span class="author"></span>
<!-- 不推荐 -->
<span class="red"></span>

1
2
3
4
5
6
7
8
9
10
11
12
13
14

[MUST] 禁止为了hook 脚本，创建无样式信息的class。

解释：不允许class只用于让JavaScript选择某些元素，class应该具有明确的语义和样式。否则容易导致CSS class泛滥。使用id、属性选择作为hook是更好的方式。

[MUST] 同一页面，禁止使用相同的name与id。

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

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

示例：

<input name="foo" />
<div id="foo"></div>
<script>
  // IE6 将显示 INPUT
  alert(document.getElementById("foo").tagName);
</script>

1
2
3
4
5
6

# 标签

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

示例：

<!-- 推荐 -->
<p>Hello StyleGuide!</p>

<!-- 不推荐 -->
<P>Hello StyleGuide!</P>

1
2
3
4
5

[MUST] 对于无需自闭合的标签，必须自闭合。

解释：虽然 html5 标准中允许空标签不用自闭合，例如常见无需自闭合标签有input、br、img、hr等。但为了统一格式，还是建议自闭合。

示例：

<!-- 推荐 -->
<input type="text" name="title" />

<!-- 不推荐 -->
<input type="text" name="title">

1
2
3
4
5

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

解释：对代码体积要求非常严苛的场景，可以例外。

示例：

<!-- 推荐 -->
<ul>
  <li>first</li>
  <li>second</li>
</ul>

<!-- 不推荐 -->
<ul>
  <li>first
  <li>second
</ul>

1
2
3
4
5
6
7
8
9
10
11

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

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

详细的标签嵌套规则参见 HTML 元素参考 (opens new window) 中每个元素的允许内容与允许的父元素部分。

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

解释：常见标签语义请参考 HTML 元素参考 (opens new window)

示例：

<!-- 推荐 -->
<p>
  Esprima serves as an important <strong>building block</strong> for some
  JavaScript language tools.
</p>

<!-- 不推荐 -->
<div>
  Esprima serves as an important <span class="strong">building block</span> for
  some JavaScript language tools.
</div>

1
2
3
4
5
6
7
8
9
10
11

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

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

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

示例：

<!-- 推荐 -->
<img class="avatar" src="image.png" />

<!-- 不推荐 -->
<span class="avatar">
  <img src="image.png" />
</span>

1
2
3
4
5
6
7

# 属性

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

示例：

<!-- 推荐 -->
<table cellspacing="0">
  ...
</table>

<!-- 不推荐 -->
<table cellSpacing="0">...</table>
  ...
</table>

1
2
3
4
5
6
7
8
9

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

解释：不允许使用单引号，不允许不使用引号。

示例：

<!-- 推荐 -->
<script src="app.js"></script>

<!-- 不推荐 -->
<script src='app.js'></script>
<script src=app.js></script>

1
2
3
4
5
6

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

示例：

<input type="text" disabled />
<input type="checkbox" value="1" checked />

1
2

[MUST] 自定义属性以data-为前缀。

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

示例：

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

# DOCTYPE

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

示例：

<!DOCTYPE html>

# compatible

[RECOMMENDED] 启用IE Edge模式。

示例：

<meta http-equiv="X-UA-Compatible" content="IE=Edge" />

# lang

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

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

示例：

<html lang="zh-CN"></html>

# 编码格式 charset

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

示例：

<html>
  <head>
    <meta charset="UTF-8" />
    ......
  </head>
  <body>
    ......
  </body>
</html>

1
2
3
4
5
6
7
8
9

# CSS 和 JavaScript 引入

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

示例：

<link rel="stylesheet" href="page.css" />

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

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

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

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

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

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

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

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

示例：

<body>
  <!-- a lot of elements -->
  <script src="init.js"></script>
</body>

1
2
3
4

[RECOMMENDED] 移动环境或只针对现代浏览器设计的 Web 应用，如果引用外部资源的URL协议部分与页面相同，建议省略协议前缀。

解释：使用protocol-relative URL引入 CSS，在IE7/8下，会发两次请求。是否使用protocol-relative URL应充分考虑页面针对的环境。

示例：

<script src="//x.y.com/static/jquery/jquery-1.10.2.min.js"></script>

# title

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

[MUST] title必须作为head的直接子元素，并紧随charset声明之后。

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

示例：

<head>
  <meta charset="UTF-8" />
  <title>页面标题</title>
</head>

1
2
3
4

# favicon

[MUST] 保证favicon可访问。

解释：在未指定favicon时，大多数浏览器会请求 Web Server 根目录下的favicon.ico。为了保证favicon可访问，避免404，必须遵循以下两种方法之一：

在 Web Server 根目录放置favicon.ico文件。
使用link指定 favicon。

示例：

<link rel="shortcut icon" href="path/to/favicon.ico" />

# 图片

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

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

[MUST] 禁止为img添加不必要的title属性。

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

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

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

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

解释：

产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片，以img形式实现，能方便用户下载。
无下载需求的图片，比如：icon、背景、代码使用的图片等，尽可能采用CSS背景图实现。

# 表单

# 控件标题

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

解释：有两种方式：

将控件置于label内。 2.label的for属性指向控件的id。

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

示例：

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

<label for="username">用户名：</label> <input type="textbox" name="username" id="username">

1
2
3

# 按钮

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

解释：

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

示例：

<button type="submit">提交</button>
<button type="button">取消</button>

1
2

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

解释：由于老版本 IE 浏览器兼容性问题，使用按钮的 name 属性会带来许多难以发现的问题。

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

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

示例：

<!-- 推荐 -->
<style>
  .buttons .button-group {
    float: right;
  }
</style>

<div class="buttons">
  <div class="button-group">
    <button type="submit">提交</button>
    <button type="button">取消</button>
  </div>
</div>

<!-- 不推荐 -->
<style>
  .buttons button {
    float: right;
  }
</style>

<div class="buttons">
  <button type="button">取消</button>
  <button type="submit">提交</button>
</div>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

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

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

示例：

<form action="/login" method="post">
  <p><input name="username" type="text" placeholder="用户名" /></p>
  <p><input name="password" type="password" placeholder="密码" /></p>
</form>

1
2
3
4

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

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

示例：

<input type="date" />

# 多媒体

[RECOMMENDED] 当在现代浏览器中使用audio以及video标签来播放音频、视频时，应当注意格式。

解释：音频应尽可能覆盖到如下格式：

视频应尽可能覆盖到如下格式：

MP4
WebM
Ogg

[RECOMMENDED] 在支持HTML5的浏览器中优先使用audio和video标签来定义音视频元素。

[RECOMMENDED] 使用退化到插件的方式来对多浏览器进行支持。

示例：

<audio controls>
  <source src="audio.mp3" type="audio/mpeg" />
  <source src="audio.ogg" type="audio/ogg" />
  <object width="100" height="50" data="audio.mp3">
    <embed width="100" height="50" src="audio.swf" />
  </object>
</audio>

<video width="100" height="50" controls>
  <source src="video.mp4" type="video/mp4" />
  <source src="video.ogg" type="video/ogg" />
  <object width="100" height="50" data="video.mp4">
    <embed width="100" height="50" src="video.swf" />
  </object>
</video>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

[RECOMMENDED] 只在必要的时候开启音视频的自动播放。

[RECOMMENDED] 在object标签内部提供指示浏览器不支持该标签的说明。

示例：

<object width="100" height="50" data="something.swf">
  DO NOT SUPPORT THIS TAG
</object>

1
2
3

编辑

上次更新: 2022/07/06, 17:35:58

← git管理规范 CSS开发规范→

HTML开发规范

# HTML开发规范

# 简介

# 内容格式与编码规范

# 缩进

# 换行

# 命名

# 标签

# 属性

# DOCTYPE

# compatible

# lang

# 编码格式 charset

# CSS 和 JavaScript 引入

# title

# favicon

# 图片

# 表单

# 控件标题

# 按钮

# 可访问性 (A11Y)

# 多媒体