html编码规范

我在财神殿里长跪不起
429 阅读6分钟

1.前言

本文档的目标是使研发中心的各位同学html能够按照统一规范进行编写，使其风格保持一致，便于理解和维护。

2.代码风格

2.1 缩进，空格

[强制] 使用 2 个空格做为一个缩进层级，不允许使用 4 个空格 或 tab 字符。(注：对于非 HTML 标签之间的缩进，比如 script 或 style 标签内容缩进，与 script 或 style 标签的缩进同级。)

示例：

<style>
/* 样式内容的第一级缩进与所属的 style 标签对齐 */
ul {
  padding: 0;
}
</style>
<ul>
  <li>first</li>
  <li>second</li>
</ul>
<script>
// 脚本代码的第一级缩进与所属的 script 标签对齐
require(['app'], function (app) {
  app.init();
});
</script>
}

2.2 行长度

[建议] 每行不得超过 120 个字符，除非单行不可分割。（注：过长的代码不容易阅读与维护。但是考虑到 HTML 的特殊性，不做硬性要求。）

2.3 命名

  1. [强制] class 驼峰命名。
  2. [强制] class 必须代表相应模块或部件的内容或功能，不得以样式信息进行命名。
  3. [强制] 元素 id 必须保证页面唯一。(注：同一个页面中，不同的元素包含相同的 id，不符合 id 的属性含义。并且使用 document.getElementById 时可能导致难以追查的问题)
  4. [强制] 禁止为了 hook 脚本，创建无样式信息的 class。(注：不允许 class 只用于让 JavaScript 选择某些元素，class 应该具有明确的语义和样式。否则容易导致 CSS class 泛滥。使用 id、属性选择作为 hook 是更好的方式。)

示例：

<!-- good -->
<div class="sideBar"></div>

<!-- bad -->
<div class="left"></div>

2.4 标签

  1. [强制] 标签名必须使用小写字母。
  2. [强制] 对于无需自闭合的标签，不允许自闭合。（注：常见无需自闭合标签有 input、br、img、hr 等。）
  3. [强制] 标签使用必须符合标签嵌套规则。（注：比如 div 不得置于 p 中，tbody 必须置于 table 中。）
  4. [建议] HTML 标签的使用应该遵循标签的语义。
  5. [建议] 标签的使用应尽量简洁，减少不必要的标签。

示例：

<!-- good -->
<p>Hello StyleGuide!</p>

<!-- bad -->
<P>Hello StyleGuide!</P>

<!-- good --> 
<input type="text" name="title">

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

2.4 属性

  1. [强制] 属性名必须使用小写字母。
  2. [强制] 属性值必须用双引号包围。（注：不允许使用单引号，不允许不使用引号。）

示例：

<!-- good -->
<table cellspacing="0">...</table>

<!-- bad -->
<table cellSpacing="0">...</table>

<!-- bad -->
<script src='esl.js'></script>
<script src=esl.js></script>

2.5属性

  1. [强制] 属性定义必须另起一行。
  2. [强制] 属性定义后必须以分号结尾。

示例：

/* good */
.selector {
  margin: 0;
  padding: 0;
}

/* bad */
.selector { margin: 0; padding: 0; }

/* good */
.selector {
  margin: 0;
}

/* bad */
.selector {
  margin: 0
}

3.通用

3.1 DOCTYPE

  1. [强制] 使用 HTML5 的 doctype 来启用标准模式，建议使用大写的 DOCTYPE。
  2. [建议] 在 html 标签上设置正确的 lang 属性。（注：有助于提高页面的可访问性，如：让语音合成工具确定其所应该采用的发音，令翻译工具确定其翻译语言等。）

示例：

<!DOCTYPE html>
<html lang="zh-CN">

3.2 编码

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

示例：

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

3.3 CSS 和 JavaScript 引入

  1. [强制] 引入 CSS 时必须指明 rel="stylesheet"。
  2. [建议] 引入 CSS 和 JavaScript 时无须指明 type 属性。（注：text/css 和 text/javascript 是 type 的默认值。）
  3. [建议] 在 head 中引入页面需要的所有 CSS 资源。（注：在页面渲染的过程中，新的CSS可能导致元素的样式重新计算和绘制，页面闪烁。）
  4. [建议] JavaScript 应当放在页面末尾，或采用异步加载。（注：将 script 放在页面中间将阻断页面的渲染。出于性能方面的考虑，如非必要，请遵守此条建议。）

示例：

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

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

4.head

4.1 title

[强制] 页面必须包含 title 标签声明标题。（注：title 中如果包含 ASCII 之外的字符，浏览器需要知道字符编码类型才能进行解码，否则可能导致乱码。）

示例：

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

4.2 favicon

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

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

示例：

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

4.3 viewport

[建议] 若页面欲对移动设备友好，需指定页面的 viewport。

viewport meta tag 可以设置可视区域的宽度和初始缩放大小，避免在移动设备上出现页面展示不正常。

比如，在页面宽度小于 980px 时，若需 iOS 设备友好，应当设置 viewport 的 width 值来适应你的页面宽度。同时因为不同移动设备分辨率不同，在设置时，应当使用 device-width 和 device-height 变量。

5 图片

  1. [强制] 禁止 img 的 src 取值为空。延迟加载的图片也要增加默认的 src。（注：src 取值为空，会导致部分浏览器重新加载一次当前页面）
  2. [建议] 避免为 img 添加不必要的 title 属性。（注：多余的 title 影响看图体验，并且增加了页面尺寸。）
  3. [建议] 为重要图片添加 alt 属性。（注：可以提高图片加载失败时的用户体验。）
  4. [建议] 添加 width 和 height 属性，以避免页面抖动。
  5. [建议] 有下载需求的图片采用 img 标签实现，无下载需求的图片采用 CSS 背景图实现。

6 表单

6.1 控件标题

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

示例：

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

6.1 按钮

  1. [强制] 使用 button 元素时必须指明 type 属性值（注：button 元素的默认 type 为 submit，如果被置于 form 元素中，点击后将导致表单提交。为显示区分其作用方便理解，必须给出 type 属性。）

示例：

<button type="submit">提交</button>
<button type="button">取消</button>
avatar
文章
阅读
粉丝