前端规范之HTML 规范

时间 2019-11-06

标签前端规范 html 栏目 HTML 繁體版

原文原文链接

其余规范：

CSS 规范javascript

媒体文件规范css

javascript 规范html

nodeJs 规范vue

vue项目规范java

摘要

优秀的项目源码，即便是多人开发，看代码也如出一人之手。统一的编码规范，可以使代码更易于阅读，易于理解，易于维护node

HTML 规范

缩进

统一两个空格缩进web

命名规范

class 应以功能或内容命名，不以表现形式命名；
class 与 id 单词字母小写，多个单词组成时，采用中划线-分隔；
使用惟一的 id 做为 Javascript hook, 同时避免建立无样式信息的 class；

DOCTYPE 声明

HTML 文件必须加上 DOCTYPE 声明，并统一使用 HTML5 的文档声明：chrome

<!DOCTYPE html>
复制代码

meta 标签

统一使用 “UTF-8” 编码

<meta charset="utf-8">
复制代码

SEO 优化

<!-- 页面关键词 -->
<meta name ="keywords" content =""/>
<!-- 页面描述 -->
<meta name ="description" content ="">
<!-- 网页做者 -->
<meta name ="author" content ="">
复制代码

优先使用 IE 最新版本和 Chrome

<meta http-equiv ="X-UA-Compatible" content ="IE = edge，chrome = 1">
复制代码

为移动设备添加视口

<!-- device-width 是指这个设备最理想的 viewport 宽度 -->
<!-- initial-scale=1.0 是指初始化的时候缩放大小是1，也就是不缩放 -->
<!-- user-scalable=0 是指禁止用户进行缩放 -->
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
复制代码

禁止自动识别页面中有多是电话格式的数字

<meta name="format-detection" content="telephone=no">
复制代码

团队约定：app

pc 端：ide

<meta charset="utf-8">
<meta name="keywords" content="your keywords">
<meta name="description" content="your description">
<meta name="author" content="author,email address">
<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
复制代码

移动端：

<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
<meta name="format-detection" content="telephone=no">
复制代码

元素属性

元素属性值使用双引号语法

推荐：

<input type="text">
复制代码

不推荐：

<input type=text>
<input type='text'>
复制代码

代码嵌套

块元素能够包含内联元素或某些块元素，但内联元素却不能包含块元素，它只能包含其它的内联元素
标题和段落中不能包含块，如：h一、h二、h三、h四、h五、h六、p、dt
块与内联不能并列，块级元素与块级元素并列、内嵌元素与内嵌元素并列
有些标签是固定的嵌套规则，好比 ul 包含 li、ol 包含 li、dl 包含 dt 和 dd 等等。

灵活使用伪类

不要让非内容信息污染了你的 HTML，打乱了 HTML 结构。能够使用:before、:after 等伪类元素

推荐：

HTML 代码

<!-- That is clean markup! -->
<span class="text-box">
  See the square next to me?
</span>

复制代码

CSS 代码：

/* We use a :before pseudo element to solve the design problem of placing a colored square in front of the text content */
.text-box:before {
  content: '';
  display: inline-block;
  width: 1rem;
  height: 1rem;
  background-color: red;
}
复制代码

不推荐：

HTML 代码：

<!-- We should not introduce an additional element just to solve a design problem -->
<span class="text-box">
  <span class="square"></span>
  See the square next to me?
</span>
复制代码

CSS 代码：

.text-box > .square {
  display: inline-block;
  width: 1rem;
  height: 1rem;
  background-color: red;
}
复制代码

特殊符号必须使用转义符

符号	描述	转义符
	空格	` `
<	小于	`<`
>	大于	`>`
&	和	`&`
"	引号	`"`

纯数字输入框

使用 type="tel" 而不是 type="number"

<input type="tel">
复制代码

类型属性

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

推荐：

<link rel="stylesheet" href="" >
<script src=""></script>
复制代码

不推荐：

<link rel="stylesheet" type="text/css" href="" >
<script type="text/javascript" src="" ></script>
复制代码

注释规范

单行注释

通常用于简单的描述，如某些状态描述、属性描述等
注释内容先后各一个空格字符，注释位于要注释代码的上面，单独占一行

推荐：

<!-- Comment Text -->
<div>...</div>
复制代码

不推荐：

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

<div><!-- Comment Text -->
    ...
</div>
复制代码

模块注释

注释内容先后各一个空格字符
表示模块开始
表示模块结束，模块与模块之间相隔一行
模块注释内部嵌套模块注释，

语义化

没有 CSS 的 HTML 是一个语义系统而不是 UI 系统
一般状况下，每一个标签都是有语义的
语义化的 HTML 结构，有助于机器（搜索引擎）理解，另外一方面多人协做时，能迅速了解开发者意图
建议页面中多使用语义化标签，而不是整个页面以 div 构成

常见标签语义：

标签	语义
`<p>`	段落
`<hn>`	标题(h1~h6)
`<ul>`	无序列表
`<ol>`	有序列表
`<nav>`	标记导航，仅对文档中重要的连接群使用
`<main>`	页面主要内容，一个页面只能使用一次。若是是 web 应用，则包围其主要功能
`<article>`	定义外部的内容，其中的内容独立于文档的其他部分
`<section>`	定义文档中的节（section、区段）。好比章节、页眉、页脚或文档中的其余部分。
`<aside>`	定义其所处内容以外的内容。如侧栏、文章的一组连接、广告、友情连接、相关产品列表
`<header>`	页眉一般包括网站标志、主导航、全站连接以及搜索框
`<footer>`	页脚，只有当父级是 body 时，才是整个页面的页脚
`<figure>`	规定独立的流内容（图像、图表、照片、代码等等）（默认有 40px 左右 margin）