En savoir plus sur les conventions de codage en HTML

Le but de ce document est de rendre le style de code HTML cohérent et facile à comprendre et à maintenir. Si vous n'avez pas cette habitude, veuillez choisir votre IDE avec soin et ne le faites pas. utilisez l'éditeur "texte"".

1 Style de code

1.1 Indentation et sauts de ligne

[Obligatoire] Utiliser 4 espaces comme un niveau d'indentation, les espaces 2 ou les caractères tab ne sont pas autorisés.

Exemple :

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

[Recommandation] Chaque ligne ne doit pas dépasser 120 caractères.

Explication :

Un code trop long n'est pas facile à lire et à maintenir. Cependant, compte tenu de la particularité du HTML, il n'y a pas d'exigences strictes. Sublime, phpstorm, wenstorm, etc. ont tous des fonctions de règle.

1.2 Dénomination

[Obligatoire] class Tous les mots doivent être en minuscules et les mots doivent être séparés par -.

[Obligatoire] class doit représenter le contenu ou la fonction du module ou du composant correspondant et ne doit pas être nommé avec des informations de style.

Exemple :

<!-- good -->
<div class="sidebar"></div>

<!-- bad -->
<div class="left"></div>

[Obligatoire] L'élément id doit être unique sur la page.

Explication :

Dans une même page, différents éléments contiennent le même identifiant, ce qui n'est pas conforme à la signification de l'attribut id. Et l'utilisation de document.getElementById peut entraîner des problèmes difficiles à retracer.

[Suggestion] id Il est recommandé que tous les mots soient en minuscules et séparés par -. Le style doit être cohérent pour un même projet.

[Recommandation] id, class les noms doivent être aussi courts que possible tout en évitant les conflits et en rendant la description claire.

Exemple :

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

<!-- good -->
<p class="comment"></p>
<!-- bad -->
<p class="com"></p>

<!-- good -->
<span class="author"></span>
<!-- bad -->
<span class="red"></span>

[Obligatoire] Évitez d'utiliser les mêmes name et id sur la même page.

Explication :

Le navigateur IE confondra les attributs id et name des éléments, et document.getElementById peut obtenir des éléments inattendus. Par conséquent, vous devez être très prudent lorsque vous nommez les attributs id et name des éléments.

Une bonne pratique consiste à utiliser une nomenclature différente pour l'identifiant et le nom.

Exemple :

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

1.3 Balises

[Obligatoire] Les noms de balises doivent utiliser des lettres minuscules.

Exemple :

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

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

[Obligatoire] La fermeture automatique n'est pas autorisée pour les tags qui n'ont pas besoin de se fermer automatiquement.

Explication :

Les balises courantes qui ne nécessitent pas de fermeture automatique incluent input, br, img, hr, etc.

Exemple :

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

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

[Obligatoire] Pour les balises de fermeture dont l'omission est autorisée comme spécifié dans HTML5, l'omission des balises de fermeture n'est pas autorisée.

Exemple :

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



    
first
    
second

[Obligatoire] L'utilisation des balises doit être conforme aux règles d'imbrication des balises.

Explication :

Par exemple, div ne doit pas être placé dans p, et tbody doit être placé dans table.

Exemple :

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

[Recommandation] HTML L'utilisation des balises doit suivre la sémantique de la balise.

Explication :

Ce qui suit sont la sémantique des balises courantes

• p - Paragraphe

• h1 ,h2,h3,h4,h5,h6 - titre hiérarchique

• fort, em - emphase

• ins - insérer

• del - supprimer

• abbr - abréviation

• code - identifiant du code

• cite - le titre de l'ouvrage à partir duquel la citation est citée

• q - citation

• blockquote - un paragraphe ou un long citation

• ul - liste non ordonnée

• ol - liste ordonnée

• dl,dt,dd - liste de définitions

Exemple :

<!-- 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 class="strong">building block</span> for some JavaScript language tools.
</div>

[Recommandation] Les tableaux ne doivent pas être utilisés pour la mise en page si CSS peut répondre à la même exigence.

Explication :

L'exactitude sémantique doit être maintenue autant que possible lorsque la compatibilité le permet. Des exceptions sont autorisées pour les scénarios comportant des exigences strictes en matière d'alignement et d'extensibilité de la grille, tels que les formulaires complexes comportant plusieurs colonnes.

[Recommandation] L'utilisation des balises doit être aussi concise que possible et réduire les balises inutiles.

Exemple :

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

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

1.4 Attributs

[Obligatoire] Les noms d'attributs doivent utiliser des lettres minuscules .

Exemple :

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

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

[Obligatoire] Les valeurs d'attribut doivent être entourées de guillemets doubles.

Explication :

Les guillemets simples ne sont pas autorisés, et aucun guillemet n'est autorisé.

Exemple :

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

<!-- bad -->
<script src=&#39;esl.js&#39;></script>
<script src=esl.js></script>

[Recommandation] Pour les attributs de type booléen, il est recommandé de ne pas ajouter de valeurs d'attribut.

Exemple :

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

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

[Recommandation] Il est recommandé que les attributs personnalisés soient préfixés par xxx- et data- est recommandé.

Explication :

L'utilisation de préfixes permet de distinguer les propriétés personnalisées des propriétés définies par standard.

Exemple :

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

2 Générique

2.1 DOCTYPE

Utilisation [obligatoire] HTML5 de doctype pour activer le mode standard, il est recommandé d'utiliser les majuscules DOCTYPE.

Exemple :

<!DOCTYPE html>

[Recommandé] Activez les modes IE Edge et Chrome Frame.

Exemple :

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

[建议] 在 html 标签上设置正确的 lang 属性。

解释：

有助于提高页面的可访问性，如：让语音合成工具确定其所应该采用的发音，令翻译工具确定其翻译语言等。

示例：

<html lang="zh-CN">

[建议] 开启双核浏览器的 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 lang="zh-CN">
    
        
        ......
    
    
        ......
    

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

解释：

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 标签将其与其标题相关联。

解释：

有两种方式：

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

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>

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!