Heim > Artikel > Web-Frontend > Erfahren Sie mehr über Codierungskonventionen in HTML
Erfahren Sie mehr über Codierungskonventionen in HTML
- 青灯夜游nach vorne
- 2020-10-22 19:40:172721Durchsuche
Das Ziel dieses Dokuments ist es, den HTML-Codestil konsistent und leicht verständlich und wartbar zu machen. Wenn Sie diese Angewohnheit nicht haben, wählen Sie bitte Ihre IDE sorgfältig aus und verwenden Sie keinen „Texteditor“.
1 Codestil
1.1 Einrückungen und Zeilenumbrüche
[Obligatorisch] Verwenden Sie 4 Leerzeichen als Einrückungsebene, 2ist nicht zulässig > Leerzeichen oder tab Zeichen. 4 个空格做为一个缩进层级，不允许使用 2 个空格 或 tab 字符。
示例：
<ul>
<li>first</li>
<li>second</li>
</ul>[建议] 每行不得超过 120 个字符。
解释：
过长的代码不容易阅读与维护。但是考虑到 HTML 的特殊性，不做硬性要求，sublime、phpstorm、wenstorm等都有标尺功能。
1.2 命名
[强制] class 必须单词全字母小写，单词间以 - 分隔。
[强制] class 必须代表相应模块或部件的内容或功能，不得以样式信息进行命名。
示例：
<!-- good --> <div class="sidebar"></div> <!-- bad --> <div class="left"></div>
[强制] 元素 id 必须保证页面唯一。
解释：
同一个页面中，不同的元素包含相同的 id，不符合 id 的属性含义。并且使用 document.getElementById 时可能导致难以追查的问题。
[建议] id 建议单词全字母小写，单词间以 - 分隔。同项目必须保持风格一致。
[建议] id、class 命名，在避免冲突并描述清楚的前提下尽可能短。
示例：
<!-- 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>
[强制] 同一页面，应避免使用相同的 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 中规定允许省略的闭合标签，不允许省略闭合标签。
示例：
<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 class="strong">building block</span> for some JavaScript language tools.
</div>[建议] 在 CSS 可以实现相同需求的情况下不得使用表格进行布局。
解释：
在兼容性允许的情况下应尽量保持语义正确性。对网格对齐和拉伸性有严格要求的场景允许例外，如多列复杂表单。
[建议] 标签的使用应尽量简洁，减少不必要的标签。
示例：
<!-- good -->
<img class="avatar" src="image.png">
<!-- bad -->
<span class="avatar">
<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>
[Empfehlung] Jede Zeile sollte 120 Zeichen nicht überschreiten.
class muss ausschließlich aus Kleinbuchstaben bestehen und die Wörter sollten durch - getrennt sein. 🎜🎜🎜🎜[Obligatorisch] class muss den Inhalt oder die Funktion des entsprechenden Moduls oder der entsprechenden Komponente darstellen und darf nicht mit Stilinformationen benannt werden. 🎜🎜🎜Beispiel: 🎜<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">🎜🎜[Pflichtig] Das 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. 🎜🎜🎜[Empfehlung] id Es wird empfohlen, alle Wörter in Kleinbuchstaben zu schreiben und Wörter durch - zu trennen. Der Stil muss für dasselbe Projekt konsistent sein. 🎜🎜🎜🎜[Empfehlung] id, class Die Benennung sollte so kurz wie möglich sein, Konflikte vermeiden und klar beschreiben. 🎜🎜🎜Beispiel: 🎜<html lang="zh-CN">🎜🎜[Pflichtfeld] Vermeiden Sie die Verwendung desselben
namen und id auf derselben Seite. 🎜🎜🎜Erklärung: 🎜🎜IE-Browser verwechselt die ID- und Namensattribute von Elementen, 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 bessere Vorgehensweise besteht darin, unterschiedliche Nomenklaturen für ID und Name zu verwenden. 🎜🎜Beispiel: 🎜<meta name="renderer" content="webkit">🎜🎜🎜1.3 Tags🎜🎜🎜🎜[Obligatorisch] Tag-Namen müssen Kleinbuchstaben enthalten. 🎜🎜Beispiel: 🎜
<link rel="dns-prefetch" href="//global.zuzuche.com/"> <link rel="dns-prefetch" href="//imgcdn1.zuzuche.com/"> <link rel="dns-prefetch" href="//qiniucdn.com/">🎜🎜[Pflichtfeld] Selbstschließen ist für Etiketten, die kein Selbstschließen erfordern, nicht zulässig. 🎜🎜🎜Erklärung: 🎜🎜Zu den gängigen Tags, die kein Selbstschließen erfordern, gehören input, br, img, hr usw. 🎜🎜Beispiel: 🎜
<html lang="zh-CN">
......
......