HTML編碼規範-html教學-PHP中文網

HTML編碼規範

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(&#39;foo&#39;).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 中規定允許省略的閉合標籤，不允許省略閉合標籤。

範例：


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


    first
    
second

登入後複製

[強制] 標籤使用必須符合標籤巢狀規則。

解釋：

例如 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=&#39;esl.js&#39;></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>
    
        
        ......
    

    
        ......

登入後複製

[建議] 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 的直接子元素，并紧随声明之后。

解释：

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編碼規範的詳細內容。更多資訊請關注PHP中文網其他相關文章！