HTML 编码规范

最新推荐文章于 2025-05-23 11:11:24 发布

郄灬灬

最新推荐文章于 2025-05-23 11:11:24 发布

阅读量523

点赞数

分类专栏：开发规范 HTML

本文链接：https://blog.youkuaiyun.com/zhu562002124/article/details/109648677

版权

开发规范同时被 2 个专栏收录

5 篇文章

订阅专栏

HTML

5 篇文章

订阅专栏

HTML 编码规范

下面有相当一部分内容引用 bootstrap 编码规范，有兴趣可以看看

编码风格

HTML 文件使用无 BOM 的 UTF-8 编码
标签不要大写，即便是 doctype 标签。
用 4 个空格来代替制表符（tab） – 这是唯一能保证在所有环境下获得一致展现的方法。
嵌套元素应当缩进一次（即两个空格）。
对于属性的定义，永远全部使用双引号，绝不要使用单引号。
不要在自闭合（self-closing）元素的尾部添加斜线 — HTML5 规范中明确说明斜线是可忽略的。
不要省略可选的结束标签（closing tag）（例如，</li> 或 </body>）。
属性与值中间的等号两边不要有空格
同一页面，不同元素，应避免使用相同的 name 与 id

示例：

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

最佳实践

HTML5 doctype

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

示例：

<!doctype html>
<html>
  <head>
  </head>
</html>

语言属性

根据 HTML5 规范：

强烈建议为 html 根元素指定 lang 属性，从而为文档设置正确的语言。这将有助于语音合成工具确定其所应该采用的发音，有助于翻译工具确定其翻译时所应遵守的规则等等。

更多关于 lang 属性的知识可以从此规范中了解。Sitepoint 站点上给出了一份语言代码表。

示例：

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

字符编码

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

示例：

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

引入 CSS 和 JavaScript 文件

根据 HTML5 规范，在引入 CSS 和 JavaScript 文件时一般不需要指定 type 属性，因为 text/css 和 text/javascript 分别是它们的默认值。
将 CSS 引入代码放在 HEAD 中
将 JavaScript 引入代码放在文档最末端，</body> 标签之前

示例：

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

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

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

实用为王

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

属性顺序

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

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

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

示例：

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

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

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

布尔（boolean）型属性

布尔型属性可以在声明时不赋值。XHTML 规范要求为其赋值，但是 HTML5 规范不需要。

更多信息请参考 WhatWG section on boolean attributes：

元素的布尔型属性如果有值，就是 true，如果没有值，就是 false。

如果一定要为其赋值的话，请参考 WhatWG 规范：

如果属性存在，其值必须是空字符串或 [...] 属性的规范名称，并且不要在首尾添加空白符。

简单来说，就是不用赋值。

示例：

<input type="text" disabled>

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

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

减少标签的数量

编写 HTML 代码时，尽量避免多余的父元素。很多时候，这需要迭代和重构来实现。

结构、表现、行为分离

CSS 和 JavaScript 抽离成单独的文件，不要在 HTML 中写样式和脚本

alt 尽量不要空着

原因如下：

网速太慢
因为用户不一定是使用浏览器
浏览器可能禁用了图片加载
用户使用的是屏幕阅读器

建议大的板块之间添加一些注释

添加注释有利于维护

示例：

    <!-- banner -->
    <div class="banner"></div>
    <!-- /banner -->

    <!-- form -->
    <div class="form"></div>
    <!-- /form -->