Skip to content

编码规范

1. DOCTYPE 声明

HTML 文件必须加上 DOCTYPE 声明,并统一使用 HTML5 的文档声明:

html
<!DOCTYPE html>

2. 页面语言

sh
<!-- 中文 -->
<html lang="zh-CN">

<!-- 简体中文 -->
<html lang="en">

3. 页面编码

项目约定

html
<meta charset="utf-8" />

团队统一写成标准的 “utf-8”, 根据 IETF 对 utf-8 的定义

4. 通用约定

标签

  • 自闭合标签,无需闭合(如:img input等)

  • 可选闭合标签,必须闭合(如:</li> </body>

class 与 ID

  • class 以功能或内容命名
  • class 与 id 单词字母小写,有多个单词时采用 - 分割 或 __ 分割
  • 标签属性都用双引号 ""

推荐:

html
<div class="head-container head-left header-right"></div>

不推荐:

html
<div class="headContainer"></div>
<div class="HEAD"></div>

引号

标签属性,统一双引号 ""

推荐:

html
<input type="text" />

不推荐:

sh
<input type=text />
<input type='text' />

特殊字符

编码中,遇到特殊字符,统一约定使用 HTML 源代码的字符实体。

推荐:

html
<a href="">更多 &gt;&gt;</a>

缩进规则

编码统一约定为 2 个空格,编辑器可做统一配置。

html
<div class="container">
  <a href="#"></a>
</div>

嵌套规则

块级元素一般作为大容器,可嵌套:文本、块级元素等等

语义嵌套约定

  • <li> 用于 <ul><ol>
  • <dd> 用于 <dl><dt>

严格嵌套约定

  • <a>标签里不可以嵌套交互式元素<a><button>
  • <p>标签里不可以嵌套块级元素<div><h1>-<h6><p>

DANGER

避免手动为标签编写行内样式,样式优先级中,会产生不必要的问题。