이 문서의 목표는 HTML 코드 스타일을 일관되고 이해하기 쉽게 만드는 것입니다. 이러한 습관이 없다면 IDE를 신중하게 선택하고 "텍스트 편집기" 사용을 중단하세요.
1.1 들여쓰기 및 줄 바꿈
[필수] 들여쓰기 수준으로 4
공백을 사용하고, 2
는 허용되지 않음 > 공백 또는 탭
문자. 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>
[强制] 标签使用必须符合标签嵌套规则。
解释:
比如 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.1 DOCTYPE
[强制] 使用 HTML5
的 doctype
来启用标准模式,建议使用大写的 DOCTYPE
<!DOCTYPE html>
[권장 사항] 각 줄은 120
자를 초과할 수 없습니다.
class
는 모두 소문자여야 하며 -
로 구분해야 합니다. 🎜🎜🎜🎜[필수] class
는 해당 모듈이나 컴포넌트의 내용이나 기능을 나타내야 하며 스타일 정보와 함께 이름을 지정할 수 없습니다. 🎜🎜🎜예: 🎜<meta http-equiv="X-UA-Compatible" content="IE=Edge,chrome=1">
id
요소는 페이지에서 고유해야 합니다. 🎜🎜🎜설명: 🎜🎜동일한 페이지에서 서로 다른 요소에 동일한 ID가 포함되어 있어 id의 속성 의미를 준수하지 않습니다. document.getElementById를 사용하면 추적하기 어려운 문제가 발생할 수 있습니다. 🎜🎜🎜[권장사항] id
모든 단어는 소문자를 사용하는 것이 좋으며, 단어는 -
로 구분되어야 합니다. 스타일은 동일한 프로젝트에 대해 일관되어야 합니다. 🎜🎜🎜🎜[권장] id
, class
이름은 충돌을 피하고 명확하게 설명하면서 최대한 짧게 지정해야 합니다. 🎜🎜🎜예: 🎜<html lang="zh-CN">
이름
과 id
를 사용하지 마세요. 🎜🎜🎜설명: 🎜🎜IE 브라우저는 요소의 ID 및 이름 속성을 혼동하므로 document.getElementById에서 예기치 않은 요소가 나타날 수 있습니다. 따라서 요소의 id 및 name 속성에 이름을 지정할 때 매우 주의해야 합니다. 🎜🎜더 나은 방법은 ID와 이름에 다른 명명법을 사용하는 것입니다. 🎜🎜예: 🎜<meta name="renderer" content="webkit">
<link rel="dns-prefetch" href="//global.zuzuche.com/"> <link rel="dns-prefetch" href="//imgcdn1.zuzuche.com/"> <link rel="dns-prefetch" href="//qiniucdn.com/">
HTML5
에서 생략이 허용된 닫는 태그의 경우 닫는 태그의 생략이 허용되지 않습니다. 🎜🎜🎜예: 🎜<link rel="stylesheet" src="page.css">
<body> <!-- a lot of elements --> <script src="init-behavior.js"></script> </body>
HTML
태그의 사용은 태그의 의미를 따라야 합니다. 🎜🎜🎜설명: 🎜🎜다음은 일반적인 태그 의미입니다.🎜<script src="//global.zuzuche.com/assets/js/gallery/jquery/1.11.2/jquery.js"></script>
CSS
인 경우 레이아웃에 테이블을 사용하면 안 됩니다. 동일한 요구 사항을 달성할 수 있습니다. 🎜🎜🎜설명: 🎜🎜호환성이 허용되는 한 의미론적 정확성을 최대한 유지해야 합니다. 여러 열이 포함된 복잡한 양식과 같이 그리드 정렬 및 확장 가능성에 대한 엄격한 요구 사항이 있는 시나리오에는 예외가 허용됩니다. 🎜🎜🎜[권장사항] 태그 사용은 최대한 간결하고 불필요한 태그를 줄여야 합니다. 🎜🎜🎜예: 🎜<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>
<label><input type="checkbox" name="confirm" value="on"> 我已确认上述条款</label> <label for="username">用户名:</label> <input type="textbox" name="username" id="username">
<button type="submit">提交</button> <button type="button">取消</button>
<!-- 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>
xxx-
접두어를 붙이는 것이 좋으며, data-
를 붙이는 것이 좋습니다. 🎜🎜🎜설명: 🎜🎜접두사를 사용하면 사용자 정의 속성과 표준 정의 속성을 구별하는 데 도움이 됩니다. 🎜🎜예: 🎜<form action="/login" method="post"> <p><input name="username" type="text" placeholder="用户名"></p> <p><input name="password" type="password" placeholder="密码"></p> </form>
HTML5
의 doctype
을 사용하세요. 다음을 권장합니다. 대문자 DOCTYPE
을 사용하세요. 🎜🎜🎜예: 🎜<input type="date"> <input type="tel"> <input type="number"> <input type="number" pattern="\d*">
<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能用吗 一文。
示例: