HTML-Codierungsstandards

HTML-Codierungsspezifikation

Das Ziel dieses Dokuments ist es, den HTML-Codestil konsistent und leicht verständlich und pflegerisch zu gestalten Wenn Sie diese Angewohnheit nicht haben, wählen Sie bitte Ihre IDE sorgfältig aus und verwenden Sie keinen „Texteditor“ mehr.

1 Codestil

1.1 Einrückung und Zeilenumbrüche

[Obligatorisch] Verwenden Sie 4 Leerzeichen als Einzug. Ebene, 2 Leerzeichen oder Tabulatorzeichen sind nicht zulässig.

Beispiel:

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

[Empfehlung] Maximal 120 Zeichen pro Zeile.

Erklärung:

Zu langer Code ist nicht einfach zu lesen und zu pflegen. In Anbetracht der Besonderheiten von HTML gibt es jedoch keine strengen Anforderungen. Sublime, PHPstorm, Wenstorm usw. verfügen alle über Linealfunktionen.

1.2 Benennung

[Obligatorisch] Die Klasse muss ausschließlich aus Kleinbuchstaben bestehen und Wörter müssen durch - getrennt werden.

[Obligatorisch] Klasse muss den Inhalt oder die Funktion des entsprechenden Moduls oder der entsprechenden Komponente darstellen und darf nicht mit Stilinformationen benannt werden.

Beispiel:

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

[Obligatorisch] Die Element-ID muss auf der Seite eindeutig sein.

Erklärung:

Auf derselben Seite enthalten verschiedene Elemente dieselbe ID, was nicht der Attributbedeutung von ID entspricht. Und die Verwendung von document.getElementById kann zu schwer nachvollziehbaren Problemen führen.

[Vorschlag] Es wird empfohlen, alle Wörter in id in Kleinbuchstaben zu schreiben und die Wörter durch - zu trennen. Der Stil muss für dasselbe Projekt konsistent sein.

[Empfehlung] Die ID- und Klassennamen sollten so kurz wie möglich sein, Konflikte vermeiden und klar beschreiben.

Beispiel:

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

[Pflichtfeld] Vermeiden Sie die Verwendung desselben Namens und derselben ID auf derselben Seite.

Erklärung:

Der IE-Browser verwechselt die ID- und Namensattribute von Elementen und document.getElementById erhält möglicherweise unerwartete Elemente. Daher müssen Sie bei der Benennung der ID- und Namensattribute von Elementen sehr vorsichtig sein.

Eine gute Vorgehensweise besteht darin, unterschiedliche Nomenklaturen für ID und Name zu verwenden.

Beispiel:

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

1.3 Tags

[Obligatorisch] Tag-Namen müssen Kleinbuchstaben enthalten.

Beispiel:

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

[Obligatorisch] Selbstschließen ist nicht für Tags zulässig, die nicht selbstschließend sein müssen.

Erklärung:

Zu den gängigen Tags, die kein Selbstschließen erfordern, gehören input, br, img, hr usw.

Beispiel:

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

[Obligatorisch] Bei schließenden Tags, die in HTML5 weggelassen werden dürfen, ist das Weglassen des schließenden Tags nicht zulässig.

Beispiel:

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


    
first
    
second

[Obligatorisch] Die Tag-Nutzung muss den Tag-Verschachtelungsregeln entsprechen.

Erklärung:

Zum Beispiel darf div nicht in p platziert werden, und tbody muss in der Tabelle platziert werden.

Beispiel:

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

[Empfehlung] Die Verwendung von HTML-Tags sollte der Semantik der Tags folgen.

Erklärung:

Die folgenden sind gängige Tag-Semantiken

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

Beispiel:

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

[Empfehlung] Tabellen sollten nicht verwendet werden, wenn CSS dasselbe erreichen kann Anforderung Erstellen Sie das Layout.

Erklärung:

Semantische Korrektheit sollte so weit wie möglich beibehalten werden, sofern die Kompatibilität dies zulässt. Ausnahmen sind für Szenarien mit strengen Anforderungen an die Rasterausrichtung und Dehnbarkeit zulässig, beispielsweise komplexe Formulare mit mehreren Spalten.

[Empfehlung] Die Verwendung von Tags sollte so prägnant wie möglich sein und unnötige Tags reduzieren.

Beispiel:

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

1.4 Attribute

[Obligatorisch] Attributnamen müssen Kleinbuchstaben verwenden.

Beispiel:

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

[Obligatorisch] Attributwerte müssen in doppelte Anführungszeichen gesetzt werden.

Erklärung:

Einfache Anführungszeichen sind nicht zulässig, und es sind keine Anführungszeichen zulässig.

Beispiel:

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

[Empfehlung] Für Attribute vom Typ Boolean wird empfohlen, keine Attributwerte hinzuzufügen.

Beispiel:

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

[Empfehlung] Es wird empfohlen, benutzerdefinierten Attributen das Präfix „xxx-“ und „data-“ voranzustellen.

Erklärung:

Die Verwendung von Präfixen hilft dabei, benutzerdefinierte Eigenschaften von standardmäßig definierten Eigenschaften zu unterscheiden.

Beispiel:

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

2 Generic

2.1 DOCTYPE

[Obligatorisch] HTML5-Doctype verwenden Um den Standardmodus zu aktivieren, wird empfohlen, DOCTYPE in Großbuchstaben zu verwenden.

Beispiel:

<!DOCTYPE html>

[Empfohlen] Aktivieren Sie den IE Edge- und Chrome Frame-Modus.

Beispiel:

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

[Vorschlag] Legen Sie das richtige lang-Attribut für das HTML-Tag fest.

Erklärung:

trägt dazu bei, die Zugänglichkeit der Seite zu verbessern, z. B. indem das Sprachsynthesetool die zu verwendende Aussprache bestimmen lässt, das Übersetzungstool die Sprache der Übersetzung bestimmen kann usw.

Beispiel:

<html>

[Empfehlung] Aktivieren Sie den Webkit-Kernel des Dual-Core-Browsers zum Rendern.

Erklärung:

Siehe den Dokumentationsartikel zum Browser-Kernel-Control-Meta-Tag.

Beispiel:

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

[Empfehlung] Aktivieren Sie DNS-Prefetching im Browser.

Erklärung:

Reduzieren Sie die Anzahl der DNS-Anfragen und rufen Sie DNS vorab ab.

Beispiel:

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

[Obligatorisch] Die Seite muss die komprimierte Form verwenden und die Zeichenkodierung explizit angeben. Das Meta, das die Zeichenkodierung angibt, muss das erste direkte untergeordnete Element von head sein.

Erklärung:

Siehe den Artikel Kann HTML5-Zeichensatz verwendet werden?

Beispiel:

<html>
    
        
        ......
    
    
        ......
    

[Empfohlen] Verwenden Sie die BOM-freie UTF-8-Kodierung für HTML-Dateien.

Erklärung:

UTF-8-Kodierung bietet eine größere Anpassungsfähigkeit. Stücklisten können bei der Verwendung von Programmen oder Tools zur Verarbeitung von Dateien unnötige Störungen verursachen.

2.3 CSS- und JavaScript-Einführung

[Obligatorisch] Bei der Einführung von CSS müssen Sie rel="stylesheet" angeben.

Beispiel:

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

[Vorschlag] Bei der Einführung von CSS und JavaScript muss das Typattribut nicht angegeben werden.

解释：

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>

Das obige ist der detaillierte Inhalt vonHTML-Codierungsstandards. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!