HTML编码标准-百分百源码网

HTML编码标准

发布时间：09/01 来源：未知浏览：关键词：

HTML编码标准

本文档的目标是使HTML代码风格保持一致，容易被懂得和被保护，假如本人没有这种习惯，请好好选中你的IDE，别再用“文本编纂器”。

1 代码风格

1.1 缩进与换行

[强迫] 使用 4 个空格做为一个缩进层级，不同意使用 2 个空格或 tab 字符。

示例：

<ul>
    <li>first</li>
    <li>second</li>
</ul>

[倡议] 每行不得超越 120 个字符。

说明：

过长的代码不容易阅读与保护。但是思考到 HTML 的非凡性，不做硬性要求，sublime、phpstorm、wenstorm等都有标尺功效。

1.2 命名

[强迫] class 必需单词全字母小写，单词间以 - 分隔。

[强迫] class 必需代表响应模块或部件的内容或功效，不得以样式信息停止命名。

示例：

<!-- good -->
<div></div>
<!-- bad -->
<div></div>

[强迫] 元素 id 必需包管页面独一。

说明：

统一个页面中，不一样的元素包括雷同的 id，不相符 id 的属性含义。并且使用 document.getElementById 时大概致使难以追查的问题。

[倡议] id 倡议单词全字母小写，单词间以 - 分隔。同项目必需保持风格一致。

[倡议] id、class 命名，在幸免冲突并描写分明的前提下尽大概短。

示例：

<!-- good -->
<div id="nav"></div>
<!-- bad -->
<div id="navigation"></div>
<!-- good -->
<p></p>
<!-- bad -->
<p></p>
<!-- good -->
<span></span>
<!-- bad -->
<span></span>

[强迫] 统一页面，应幸免使用雷同的 name 与 id。

说明：

IE 阅读器会混淆元素的 id 和 name 属性， document.getElementById 大概获得不盼望的元素。所以在对元素的 id 与 name 属性的命名需要非常当心。

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

示例：

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

1.3 标签

[强迫] 标签名必需使用小写字母。

示例：

<!-- good -->
<p>Hello StyleGuide!</p>
<!-- bad -->
<P>Hello StyleGuide!</P>

[强迫] 关于无需自闭合的标签，不同意自闭合。

说明：

常见无需自闭合标签有input、br、img、hr等。

示例：

<!-- good -->
<input type="text" name="title">
<!-- bad -->
<input type="text" name="title" />

[强迫] 对 HTML5 中规定同意省略的闭合标签，不同意省略闭合标签。

示例：

<!-- good -->
<ul>
    <li>first</li>
    <li>second</li>
</ul>
<!-- bad -->
<ul>
    <li>first
    <li>second
</ul>

[强迫] 标签使用必需相符标签嵌套规则。

说明：

比方 div 不得置于 p 中，tbody 必需置于 table 中。

示例：

<!-- good -->
<div><h1><span></span></h1></div>
<a href=""><span></span></a>
<!-- bad -->
<span><div></div></span>
<p><div></div></p>
<h1><div></div></h1>
<h6><div></div></h6>
<a href="a.html"><a href="a.html"></a></a>

[倡议] HTML 标签的使用应当遵照标签的语义。

说明：

下面是常见标签语义

p - 段落
h1,h2,h3,h4,h5,h6 - 层级标题
strong,em - 强调
ins - 插入
del - 删除
abbr - 缩写
code - 代码标识
cite - 引述来源作品的标题
q - 援用
blockquote - 一段或长篇援用
ul - 无序列表
ol - 有序列表
dl,dt,dd - 定义列表

示例：

<!-- good -->
<p>Esprima serves as an important <strong>building block</strong> for some JavaScript language tools.</p>
<!-- bad -->
<div>Esprima serves as an important <span>building block</span> for some JavaScript language tools.</div>

[倡议] 在 CSS 可以实现雷同需求的状况下不得使用表格停止规划。

说明：

在兼容性同意的状况下应尽量保持语义准确性。对网格对齐和拉伸性有严厉要求的场景同意例外，如多列复杂表单。

[倡议] 标签的使用应尽量简约，减少不必要的标签。

示例：

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

1.4 属性

[强迫] 属性名必需使用小写字母。

示例：

<!-- good -->
<table cellspacing="0">...</table>
<!-- bad -->
<table cellSpacing="0">...</table>

[强迫] 属性值必需用双引号包抄。

说明：

不同意使用单引号，不同意不使用引号。

示例：

<!-- good -->
<script src="esl.js"></script>
<!-- bad -->
<script src='esl.js'></script>
<script src=esl.js></script>

[倡议] 布尔类型的属性，倡议不增加属性值。

示例：

<!-- good -->
<input type="text" disabled>
<input type="checkbox" value="1" checked>
<!-- bad -->
<input type="text" disabled="disabled">
<input type="checkbox" value="1" checked="checked">

[倡议] 自定义属性倡议以 xxx- 为前缀，引荐使用 data-。

说明：

使用前缀有助于区分自定义属性和标准定义的属性。

示例：

<ol data-ui-type="Select"></ol>

2 通用

2.1 DOCTYPE

[强迫] 使用 HTML5 的 doctype 来启用标准模式，倡议使用大写的 DOCTYPE。

示例：

<!DOCTYPE html>

[倡议] 启用 IE Edge 和 Chrome Frame 模式。

示例：

<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">

[倡议] 在 html 标签上设定准确的 lang 属性。

说明：

有助于提高页面的可拜访性，如：让语音合成工具肯定其所应当采纳的发音，令翻译工具肯定其翻译说话等。

示例：

<html>

[倡议] 开启双核阅读器的 webkit 内核停止渲染。

说明：

见阅读器内核操纵Meta标签说明文档一文。

示例：

<meta name="renderer" content="webkit">

[倡议] 开启阅读器的DNS预猎取。

说明：

减少DNS恳求次数、对DNS停止预猎取。

示例：

<link rel="dns-prefetch" href="//global.zuzuche.com/">
<link rel="dns-prefetch" href="//imgcdn1.zuzuche.com/">
<link rel="dns-prefetch" href="//qiniucdn.com/">

2.2 编码

[强迫] 页面必需使用精简情势，明白指定字符编码。指定字符编码的 meta 必需是 head 的第一个直接子元素。

说明：

见 HTML5 Charset能用吗一文。

示例：

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

[倡议] HTML 文件使用无 BOM 的 UTF-8 编码。

说明：

UTF-8 编码具有更广泛的顺应性。BOM 在使用程序或工具处置文件时大概造成不必要的干扰。

2.3 CSS和JavaScript引入

[强迫] 引入 CSS 时必需指明 rel="stylesheet"。

示例：

<link rel="stylesheet" src="page.css">

[倡议] 引入 CSS 和 JavaScript 时不必指明 type 属性。

说明：

text/css 和 text/javascript 是 type 的默许值。

[倡议] 展示定义放置于外部 CSS 中，行动定义放置于外部 JavaScript 中。

说明：

构造-样式-行动的代码别离，关于提高代码的可阅读性和保护性都有好处。

[倡议] 在 head 中引入页面需要的所有 CSS 资源。

说明：

在页面渲染的历程中，新的CSS大概致使元素的样式从新运算和绘制，页面闪耀。

[倡议] JavaScript 应当放在页面末尾，或采纳异步加载。

说明：

将 script 放在页面中心将阻断页面的渲染。出于机能方面的思考，如非必要，请遵照此条倡议。

示例：

<body>
    <!-- a lot of elements -->
    <script src="init-behavior.js"></script>
</body>

[强迫] 援用静态资源的 URL 和谈部分与页面雷同，倡议省略和谈前缀。

示例：

<script src="//global.zuzuche.com/assets/js/gallery/jquery/1.11.2/jquery.js"></script>

3 Head

3.1 title

[强迫] 页面必需包括 title 标签声明标题。

[强迫] title 必需作为 head 的直接子元素，并紧随 <link rel="dns-prefetch"> 声明之后。

说明：

title 中假如包括 ascii 之外的字符，阅读器需要知道字符编码类型才能停止解码，不然大概致使乱码。

示例：

<head>
    <meta charset="UTF-8">
    <link rel="dns-prefetch" href="//global.zuzuche.com/">
    <link rel="dns-prefetch" href="//imgcdn1.zuzuche.com/">
    <link rel="dns-prefetch" href="//qiniucdn.com/">
    <title>页面标题</title>
</head>

4 图片

[强迫] 制止 img 的 src 取值为空。延迟加载的图片也要增添默许的 src。

说明：

src 取值为空，会致使部分阅读重视新加载一次当前页面，参照：

https://developer.yahoo.com/performance/rules.html#emptysrc

[倡议] 幸免为 img 增加不必要的 title 属性。

说明：

余外的 title 影响看图体验，并且增添了页面尺寸。

[倡议] 为重要图片增加 alt 属性。

说明：

可以提高图片加载失败时的会员体验。

[倡议] 增加 width 和 height 属性，以幸免页面颤动。

[倡议] 有下载需求的图片采纳 img 标签实现，无下载需求的图片采纳 CSS 背景图实现。

说明：

产品 logo、会员头像、会员发生的图片等有潜鄙人载需求的图片，以 img 情势实现，能利便会员下载。

无下载需求的图片，比方：icon、背景、代码使用的图片等，尽大概采纳 css 背景图实现。

5 表单

5.1 控件标题

[强迫] 有文本标题的控件必需使用 label 标签将其与其标题相关联。

说明：

有两种方式：

将控件置于 label 内。

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">

5.2 按钮

[强迫] 使用 button 元素时必需指明 type 属性值。

说明：

button 元素的默许 type 为 submit，假如被置于 form 元素中，点击后将致使表单提交。为显示区分其作用利便懂得，必需给出 type 属性。

示例：

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

[倡议] 尽量不要使用按钮类元素的 name 属性。

说明：

由于阅读器兼容性问题，使用按钮的 name 属性会带来很多难以发明的问题。详细状况可参照此文。

5.3 可拜访性 (A11Y)

[倡议] 负责主要功效的按钮在 DOM 中的次序应靠前。

说明：

负责主要功效的按钮应相对靠前，以提高可拜访性。假如在 CSS 中指定了 float: right 则大概致使视觉上主按钮在前，而 DOM 中主按钮靠后的状况。

示例：

<!-- good -->
<style>
.buttons .button-group {
    float: right;
}
</style>
<div>
    <div>
        <button type="submit">提交</button>
        <button type="button">取消</button>
    </div>
</div>
<!-- bad -->
<style>
.buttons button {
    float: right;
}
</style>
<div>
    <button type="button">取消</button>
    <button type="submit">提交</button>
</div>

[倡议] 当使用 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>

[倡议] 在针对移动设备开发的页面时，按照内容类型指定输入框的 type 属性。

说明：

按照内容类型指定输入框类型，能获得能友好的输入体验。

示例：

<input type="date">
<input type="tel">
<input type="number">
<input type="number" pattern="\d*">

6 模板中的 HTML

[倡议] 模板代码的缩进优先包管 HTML 代码的缩进规则。

示例：

<!-- good -->
<!-- IF is_display -->
<div>
    <ul>
        <!-- BEGIN item_list -->
        <li>{name}<li>
        <!-- END item_list -->
    </ul>
</div>
<!-- ENDIF item_list -->
<!-- bad -->
<!-- IF is_display -->
    <div>
        <ul>
    <!-- BEGIN item_list -->
        <li>{$item.name}<li>
    <!-- END item_list -->
        </ul>
    </div>
<!-- ENDIF item_list -->

[倡议] 模板代码应以包管 HTML 单个标签语法的准确性为根本原则。

示例：

<!-- good -->
<li class="<!-- IF selected --> selected<!-- ENDIF selected -->">{type_name}</li>
<!-- bad -->
<li <!-- IF selected --><!-- ENDIF selected -->>{type_name}</li>

[倡议] 模板代码应以包管完毕符的闭合名

示例：

<!-- good -->
<!-- IF is_display -->
<div>
    <!-- BEGIN item_list -->
    <ul>
        <!-- BEGIN package_list -->
        <li>
            <span>{name}：</span><span>￥{unit_price}</span>
        <li>
        <!-- END package_list -->
    </ul>
    <!-- END item_list -->
</div>
<!-- ENDIF is_display -->
<!-- bad -->
<!-- IF is_display -->
<div>
    <!-- BEGIN item_list -->
    <ul>
        <!-- BEGIN package_list -->
        <li>
            <span>{name}：</span><span>￥{unit_price}</span>
        <li>
        <!-- END -->
    </ul>
    <!-- END -->
</div>
<!-- ENDIF -->

[倡议] 在轮回处置模板数据结构表格时，若要求每行输出牢固的个数，倡议先将数据分组，之后再轮回输出，模板只是做数据展现，别加插太多业务逻辑（其他数据结构同理）。

示例：

<!-- good -->
<table>
    <!-- BEGIN item_list -->
    <tr>
        <!-- BEGIN package_list -->
        <td>
            <span>{name}：</span><span>￥{unit_price}</span>
        </td>
        <!-- END package_list -->
    <tr>
    <!-- END item_list -->
</table>
<!-- bad -->
<table>
<tr>
    <!-- BEGIN item_list -->
    <td>
        <span>{name}：</span><span>￥{unit_price}</span>
    </td>
        <!-- IF id="5" -->
    </tr>
    <tr>
        <!-- ENDIF id -->
    <!-- END item_list -->
</tr>
</table>
<!-- good -->
<table>
    <!-- BEGIN item_list -->
    <tr>
        <!-- BEGIN package_list -->
        <td>
            <span>{name}：</span><span>￥{price}</span>
        </td>
        <!-- END package_list -->
    <tr>
    <!-- END item_list -->
</table>
<!-- bad -->
<table>
<!-- BEGIN item_list -->
<tr>
    <td>
        <span>{name}：</span>
        <!-- IF type="unit" -->
        <span>￥{unit_price}</span>
        <!-- ELSEIF type="total" -->
        <span>￥{total_price}</span>
        <!-- ENDIF type -->
    </td>
</tr>
<!-- END item_list -->
</tr>
</table>

以上就是HTML编码标准的具体内容，更多请关注百分百源码网其它相关文章！

打赏