HTML代码规范

会思想的苇草i

已于 2024-05-07 16:49:25 修改

阅读量812

点赞数 22

分类专栏：前端文章标签： html 代码规范前端 eslint 工程化

于 2024-04-08 11:28:58 首次发布

本文链接：https://blog.csdn.net/ASHIYI66/article/details/136058387

版权

前端专栏收录该内容

47 篇文章 9 订阅

订阅专栏

HTML代码规范

HTML代码规范

HTML代码规范

黄金定律：永远遵循同一套编码规范 —— 可以参考其他规范，也可以是自己总结制定的。不管有多少人共同参与同一项目，一定要确保每一行代码都像是同一个人编写的。
编辑器配置
- 将编辑器按照下面的配置进行设置，以避免常见的代码不一致和差异：
  - 用两个空格代替制表符。
  - 保存文件时，删除尾部的空白符。
  - 设置文件编码为 UTF-8。
  - 在文件结尾添加一个空白行。
- 可以参照文档并将这些配置信息添加到项目的 .editorconfig 文件中。

语法

标签不要大写，即便是 doctype 标签；
用两个空格来代替制表符（tab）；
嵌套元素应当缩进一次（即两个空格）。
对于属性的定义，永远全部使用双引号，不要使用单引号；
不要在自闭合（self-closing）元素的尾部添加斜线；
不要省略可选的结束标签（closing tag）（例如，< /li > 或 < /body >）

<!doctype html>
<html>
  <head>
    <title>Page title</title>
  </head>
  <body>
    <img src="image.png" alt="image">
    <h1 class="hello-world">Hello, world!</h1>
  </body>
</html>

HTML5 doctype

为每个 HTML 页面的第一行添加 standards mode（标准模式）声明，这样能够确保在每个浏览器中拥有一致的展现。

<!doctype html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <title>Hello World!</title>
  </head>
  <body>
  </body>
</html>

语言属性

根据 HTML5 规范：强烈建议为 html 根元素指定 lang 属性，从而为文档设置正确的语言。这将有助于语音合成工具确定其所应该采用的发音，有助于翻译工具确定其翻译时所应遵守的规则等等。
Sitepoint 站点上给出了一份 语言代码表。

<html lang="en">
  <!-- ... -->
</html>

IE 兼容模式

IE 支持通过特定的标签来确定绘制当前页面所应该采用的 IE 版本。除非有强烈的特殊需求，否则最好是设置为 edge mode，从而通知 IE 采用其所支持的最新的绘制模式。

<meta http-equiv="x-ua-compatible" content="ie=edge">

字符编码

通过明确声明字符编码，能够确保浏览器快速并容易的判断页面内容的渲染方式。这样做的好处是，可以避免在 HTML 中使用字符实体标记（character entity），从而全部与文档编码一致（一般采用 UTF-8 编码）。

<head>
  <meta charset="UTF-8">
</head>

引入 CSS 和 JavaScript 文件

根据 HTML5 规范，在引入 CSS 和 JavaScript 文件时一般不需要指定 type 属性，因为 text/css 和 text/javascript 分别是它们的默认值。

<!-- External CSS -->
<link rel="stylesheet" href="code-guide.css">

<!-- In-document CSS -->
<style>
  /* ... */
</style>

<!-- JavaScript -->
<script src="code-guide.js"></script>

实用为王

尽量遵循 HTML 标准和语义，但是不要以牺牲实用性为代价。任何时候都要尽量使用最少的标签并保持最小的复杂度。

属性顺序

HTML 属性应当按照以下给出的顺序依次排列，确保代码的易读性。
1. class
2. id, name
3. data- *
4. src, for, type, href, value
5. title, alt
6. role, aria- *
class 用于标识高度可复用组件，因此应该排在首位。id 用于标识具体组件，应当谨慎使用（例如，页面内的书签），因此排在第二位。

<a class="..." id="..." data-toggle="modal" href="#">
  Example link
</a>

<input class="form-control" type="text">

<img src="..." alt="...">

布尔型属性

布尔型属性可以在声明时不赋值。

<input type="text" disabled>

<input type="checkbox" value="1" checked>

<select>
  <option value="1" selected>1</option>
</select>

减少标签的数量

编写 HTML 代码时，尽量避免多余的父元素。

<!-- Not so great -->
<span class="avatar">
  <img src="...">
</span>

<!-- Better -->
<img class="avatar" src="...">

JavaScript 生成的标签

通过 JavaScript 生成的标签让内容变得不易查找、编辑，并且降低性能。能避免时尽量避免。

// Not recommended
// 创建 <span> 元素
var spanTag = document.createElement('span');

// 设置属性
spanTag.textContent = "这是动态生成的 span 标签";
spanTag.style.color = "red";

// 将 <span> 元素添加到文档中的某个元素中，比如 body
document.body.appendChild(spanTag);