html编码规范

时间 2019-12-20

标签 html 编码规范栏目 HTML 繁體版

原文原文链接

不久前接到老大下达的任务，要拟定一份公司前端编码规范的草稿，参考了各大公司的编码规范，结合如今公司的特色，整理出如下编码规范：

html规范

1 文件相关

(1) 文件名以英文为主，可使用下划线(如active.html)，压缩包以项目名+日期的形式。
(2) 统一使用utf-8编码。
(3) css、js发布到线上都须要压缩。
(4) 在追求高度优化的站点，须要对图片也进行无损压缩。javascript

2 代码风格

2.1 命名

(1) 元素 id 必须保证页面惟一。（解释：同一个页面中，不一样的元素包含相同的 id，不符合 id 的属性含义。而且使用 document.getElementById 时可能致使难以追查的问题。）
(2) id建议单词全字母小写，单词间以"_"分隔。同项目必须保持风格一致。
(3) class必须单词全字母小写，单词间以"_"分隔。
(4) class命名最好表明相应模块或部件的内容或功能。
(5) id、class 命名，在避免冲突并描述清楚的前提下尽量短。
(6) 同一页面，应避免使用相同的 name 与 id。(解释：IE 浏览器会混淆元素的 id 和 name 属性， document.getElementById 可能得到不指望的元素。因此在对元素的 id 与 name 属性的命名须要很是当心。)
示例： css

<input name="foo">
<div id="foo"></div>
<script>
// IE6 将显示 INPUT
alert(document.getElementById('foo').tagName);
</script>

2.2 标签

(1) 标签名必须使用小写字母。
html

(2) 标签使用必须符合标签嵌套规则。（解释：如<p>里不能够嵌套块级元素<div>、<h1>~<h6>、<p>、<ul>/<ol> /<li>、<dl>/<dt>/<dd>、<form>;tbody 必须置于 table 中;inline-Level 元素，仅能够包含文本或其它 inline-Level 元素;<a>里不能够嵌套交互式元素<a>、<button>、<select>等。）
(3) HTML 标签的使用应该遵循标签的语义。
下面是常见标签语义:
  p - 段落
  h1,h2,h3,h4,h5,h6 - 层级标题
  strong,em - 强调
  ins - 插入
  del - 删除
  abbr - 缩写
  code - 代码标识
  cite - 引述来源做品的标题
  q - 引用
  blockquote - 一段或长篇引用
  ul - 无序列表
  ol - 有序列表
  dl,dt,dd - 定义列表
(4) 标签的使用应尽可能简洁，减小没必要要的标签。
示例：前端

<!-- good -->
<img class="avatar" src="image.png">

<!-- bad -->
<span class="avatar">
    <img src="image.png">
</span>

2.3 属性

(1) 属性名必须使用小写字母。
(2) 属性值必须用双引号包围。
(3) HTML 属性应当按照如下给出的顺序依次排列，确保代码的易读性(class,id, name,data-*,src, for, type, href,title, alt,aria-*, role。解释：class 用于标识高度可复用组件，所以应该排在首位。id 用于标识具体组件，应当谨慎使用（例如，页面内的书签），所以排在第二位。)
(4) 布尔类型的属性（如disabled、checked、selected 等属性），建议不添加属性值。
示例： java

<input type="text" disabled>
<input type="checkbox" value="1" checked>
<select>
  <option value="1" selected>1</option>
</select>

(4) 自定义属性建议以 xxx- 为前缀，推荐使用 data-（解释：使用前缀有助于区分自定义属性和标准定义的属性。）
浏览器

3 通用

3.1 DOCTYPE

(1) 使用 HTML5 的 doctype 来启用标准模式，建议使用大写的 DOCTYPE。
示例：异步

<!DOCTYPE html>

(2) 在 html 标签上设置正确的 lang 属性。（解释：有助于提升页面的可访问性，如：让语音合成工具肯定其所应该采用的发音，令翻译工具肯定其翻译语言等。）ide

3.2 编码

(1) 页面必须使用精简形式，明确指定字符编码。指定字符编码的 meta 必须是 head 的第一个直接子元素。
示例：工具

<html>
    <head>
        <meta charset="utf-8">
        ......
    </head>
    <body>
        ......
    </body>
</html>

3.3 CSS 和 JavaScript 引入

(1) 引入 CSS 时必须指明 rel="stylesheet"。
(2) 引入 CSS 和 JavaScript 时无须指明 type 属性。（解释：text/css 和 text/javascript 是 type 的默认值。）
(3) 展示定义放置于外部 CSS 中，行为定义放置于外部 JavaScript 中。（解释：结构-样式-行为的代码分离，对于提升代码的可阅读性和维护性都有好处。）
(4) 在 head 中引入页面须要的全部 CSS 资源。（解释：在页面渲染的过程当中，新的CSS可能致使元素的样式从新计算和绘制，页面闪烁。）
(5) JavaScript 应当放在页面末尾，或采用异步加载。（解释：将 script 放在页面中间将阻断页面的渲染。出于性能方面的考虑，如非必要，请遵照此条建议。）
post

4 head

4.1 title

(1) 页面必须包含 title 标签声明标题。
(2) title 必须做为 head 的直接子元素，并紧随 charset 声明以后。（解释：title 中若是包含 ASCII 以外的字符，浏览器须要知道字符编码类型才能进行解码，不然可能致使乱码。）
示例：

<head>
    <meta charset="utf-8">
    <title>页面标题</title>
</head>

4.2 favicon

(1) 保证 favicon 可访问。
（解释：在未指定 favicon 时，大多数浏览器会请求 Web Server 根目录下的 favicon.ico 。为了保证 favicon 可访问，避免 404，必须遵循如下两种方法之一：1.在 Web Server 根目录放置 favicon.ico 文件;2.使用 link 指定 favicon。）
示例：

<link rel="shortcut icon" href="path/to/favicon.ico">

4.3 viewport

若页面欲对移动设备友好，需指定页面的 viewport。
（解释：viewport meta tag 能够设置可视区域的宽度和初始缩放大小，避免在移动设备上出现页面展现不正常。好比，在页面宽度小于 980px 时，若需 iOS 设备友好，应当设置 viewport 的 width 值来适应你的页面宽度。同时由于不一样移动设备分辨率不一样，在设置时，应当使用 device-width 和 device-height 变量。）

5 图片

(1) 禁止 img 的 src 取值为空。延迟加载的图片也要增长默认的 src。（解释：src 取值为空，会致使部分浏览器从新加载一次当前页面。）
(2)避免为 img 添加没必要要的 title 属性。（解释：多余的 title 影响看图体验，而且增长了页面尺寸。）
(3) 添加 width 和 height 属性，以免页面抖动。
(4)有下载需求的图片采用 img 标签实现，无下载需求的图片采用 CSS 背景图实现。（解释：1.产品 logo、用户头像、用户产生的图片等有潜在下载需求的图片，以 img 形式实现，能方便用户下载。2.无下载需求的图片，好比：icon、背景、代码使用的图片等，尽量采用 CSS 背景图实现。）
(5)原则上，img标签内必须注明 alt 属性。
(6)当img标签外嵌套了<a>标签，则必须注明 title 属性。

6 表单

6.1 控件标题

(1)有文本标题的控件必须使用 label 标签将其与其标题相关联。（解释：有两种方式：1.将控件置于 label 内;2.label 的 for 属性指向控件的 id。推荐使用第一种，减小没必要要的 id。若是 DOM 结构不容许直接嵌套，则应使用第二种。）
示例：

<label><input type="checkbox" name="confirm" value="on"> 我已确认上述条款</label>
<label for="username">用户名：</label> <input type="textbox" name="username" id="username">

(2)表单外必须嵌套

标签。

6.2 按钮

(1)使用 button 元素时必须指明 type 属性值。（解释：button 元素的默认 type 为 submit，若是被置于 form 元素中，点击后将致使表单提交。为显示区分其做用方便理解，必须给出 type 属性。）
示例：

<button type="submit">提交</button>
<button type="button">取消</button>

(2)尽可能不要使用按钮类元素的 name 属性。（解释：因为浏览器兼容性问题，使用按钮的 name 属性会带来许多难以发现的问题。）
示例：

6.3 可访问性

(1)当使用 JavaScript 进行表单提交时，若是条件容许，应使原生提交功能正常工做。（解释：当浏览器 JS 运行错误或关闭 JS 时，提交功能将没法工做。若是正确指定了 form 元素的 action 属性和表单控件的 name 属性时，提交仍可继续进行。）
示例：

<form action="/login" method="post">
    <p><input name="username" type="text" placeholder="用户名"></p>
    <p><input name="password" type="password" placeholder="密码"></p>
</form>

(2)在针对移动设备开发的页面时，根据内容类型指定输入框的 type 属性。（解释：音频应尽量覆盖到以下格式：MP三、WAV、Ogg;视频应尽量覆盖到以下格式：MP四、WebM、Ogg。）
示例：

<input type="date">

7 多媒体

(1)当在现代浏览器中使用 audio 以及 video 标签来播放音频、视频时，应当注意格式。（解释：button 元素的默认 type 为 submit，若是被置于 form 元素中，点击后将致使表单提交。为显示区分其做用方便理解，必须给出 type 属性。）
(2)在支持 HTML5 的浏览器中优先使用 audio 和 video 标签来定义音视频元素。
示例：

<audio controls>
    <source src="audio.mp3" type="audio/mpeg">
    <source src="audio.ogg" type="audio/ogg">
    <object width="100" height="50" data="audio.mp3">
        <embed width="100" height="50" src="audio.swf">
    </object>
</audio>

<video width="100" height="50" controls>
    <source src="video.mp4" type="video/mp4">
    <source src="video.ogg" type="video/ogg">
    <object width="100" height="50" data="video.mp4">
        <embed width="100" height="50" src="video.swf">
    </object>
</video>

(4)只在必要的时候开启音视频的自动播放。
(5)在 object 标签内部提供指示浏览器不支持该标签的说明。
示例：

<object width="100" height="50" data="something.swf">DO NOT SUPPORT THIS TAG</object>