CODING 修炼小册

HTML 规范

# HTML 规范

# 文件模板

HTML5 文件模板：

<!DOCTYPE html>
  <html lang="zh-CN">
  <head>
    <meta charset="UTF-8">
    <title>HTML5 标准模版</title>
  </head>
  <body>
  </body>
</html>
1
2
3
4
5
6
7
8
9

移动端：

<!DOCTYPE html>
<html lang="zh-CN">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" 
        content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no, shrink-to-fit=no">
  <meta name="format-detection" content="telephone=no">
  <title>移动端 HTML 模版</title>

  <!-- S DNS预解析 -->
  <link rel="dns-prefetch" href="">
  <!-- E DNS预解析 -->

  <!-- S 线上样式页面片，开发请直接取消注释引用 -->
  <!-- #include virtual="" -->
  <!-- E 线上样式页面片 -->

  <!-- S 本地调试，根据开发模式选择调试方式，请开发删除 -->
  <link rel="stylesheet" href="css/index.css">
  <!-- /本地调试方式 -->

  <link rel="stylesheet" href="http://srcPath/index.css">
  <!-- /开发机调试方式 -->
  <!-- E 本地调试 -->

</head>
<body>
</body>
</html>
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
26
27
28
29

# 属性顺序

HTML 属性应当按照以下给出的顺序依次排列，确保代码的易读性。

  • class
  • id，name
  • data-*
  • src，for，type，href，value
  • title，alt
  • role，aria-*

class 用于标识高度可复用组件，因此应该排在首位。

id 用于标识具体组件，应当谨慎使用（例如，页面内的书签），因此排在第二位。

# class 命名

  • class 必须单词全字母小写，单词间以 - 分隔。
  • class 必须代表相应模块或部件的内容或功能，不得以样式信息进行命名。
  • 避免过度任意的简写。.btn 代表 button，但是 .s 不能表达任何意思。
  • 基于最近的父 class 或基本（base） class 作为新 class 的前缀。

# id 命名

  • 元素 id 必须保证页面唯一。
  • id 建议单词全字母小写，单词间以 - 分隔。同项目必须保持风格一致。
  • id、class 命名，在避免冲突并描述清楚的前提下尽可能短。

# name 命名

  • 同一页面，应避免使用相同的 name 与 id。
  • name 一般与后端 model 中的字段名命名规则保持一致。
    • 例如 Java 使用小驼峰命名法（camelCase），Python使用下划线 _ 连接两个小写单词。

解释：

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

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

# 标签类型属性

不需要为 CSS、JS 指定类型属性，HTML5 中默认已包含。

推荐：

<link rel="stylesheet" href="" >
<script src=""></script>
1
2

不推荐：

<link rel="stylesheet" type="text/css" href="" >
<script type="text/javascript" src="" ></script>
1
2

# 代码嵌套

  • 元素嵌套规范，每个块状元素独立一行，内联元素可选。

推荐：

<div>
  <h1></h1>
  <p></p>
</div>
<p><span></span><span></span></p>
1
2
3
4
5

不推荐：

<div>
  <h1></h1><p></p>
</div>
<p> 
  <span></span>
  <span></span>
</p>
1
2
3
4
5
6
7
  • 段落元素与标题元素只能嵌套内联元素。

推荐：

<h1><span></span></h1>
<p><span></span><span></span></p>
1
2

不推荐：

<h1><div></div></h1>
<p><div></div><div></div></p>
1
2

# 注释规范

# 单行注释

一般用于简单的描述，如某些状态描述、属性描述等。

注释内容前后各一个空格字符，注释位于要注释代码的上面，单独占一行。

推荐：

<!-- Comment Text -->
<div>...</div>
1
2

不推荐：

<div>...</div><!-- Comment Text -->

<div><!-- Comment Text -->
  ...
</div>
1
2
3
4
5

# 模块注释

一般用于描述模块的名称以及模块开始与结束的位置。

注释内容前后各一个空格字符，<!-- S Comment Text --> 表示模块开始，<!-- E Comment Text --> 表示模块结束，模块与模块之间相隔一行。

推荐：

<!-- S Comment Text A -->
<div class="mod-a">
  ...
</div>
<!-- E Comment Text A -->

<!-- S Comment Text B -->
<div class="mod-b">
  ...
</div>
<!-- E Comment Text B -->
1
2
3
4
5
6
7
8
9
10
11

不推荐：

<!-- S Comment Text A -->
<div class="mod_a">
  ...
</div>
<!-- E Comment Text A -->
<!-- S Comment Text B -->
<div class="mod_b">
  ...
</div>
<!-- E Comment Text B -->
1
2
3
4
5
6
7
8
9
10

# 嵌套模块注释

当模块注释内再出现模块注释的时候，为了突出主要模块，嵌套模块改用 <!-- /Comment Text -->。

注释写在模块结尾标签底部，单独一行。

<!-- S Comment Text A -->
<div class="mod-a">

  <div class="mod-b">
    ...
  </div>
  <!-- /mod-b -->

  <div class="mod-c">
    ...
  </div>
  <!-- /mod-c -->

</div>
<!-- E Comment Text A -->
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

（完）

CSS 规范