Code Guide by @AlloyTeam
命名规则
项目命名
全部采用小写方式,以下划线分隔。
例:my_project_name
目录命名
参照项目命名规则。
例:image, js, css
HTML文件命名
参照项目命名规则。
例:error_report.html
JS文件命名
参照项目命名规则。
例:account_model.js
CSS文件命名
参照项目命名规则。
例:retina_sprites.scss
HTML
语法
缩进使用soft tab(4个空格);
嵌套的节点应该缩进;
在属性上,使用双引号,不要使用单引号;
属性名全小写,用中划线做分隔符;
例:data-attr
不要在自动闭合标签结尾处使用斜线(HTML5 规范 指出他们是可选的);
自动闭合标签:area、base, br, col, command, embed, hr, img, input, keygen, link, meta, param, source, track, wbr
不要忽略可选的关闭标签;
例:</li> 和 </body>
。
|
|
HTML5 doctype
在页面开头使用这个简单地doctype来启用标准模式,使其在每个浏览器中尽可能一致的展现;
虽然doctype不区分大小写,但是按照惯例,doctype大写 (关于html属性,大写还是小写)。
lang属性
根据HTML5规范:
应在html标签上加上lang属性。这会给语音工具和翻译工具帮助,告诉它们应当怎么去发音和翻译。
更多关于 lang 属性的说明在这里;
在sitepoint上可以查到语言列表;
但sitepoint只是给出了语言的大类,例如中文只给出了zh,但是没有区分香港,台湾,大陆。而微软给出了一份更加详细的语言列表.aspx),其中细分了zh-cn, zh-hk, zh-tw。
|
|
字符编码
通过声明一个明确的字符编码,让浏览器轻松、快速的确定适合网页内容的渲染方式,通常指定为’UTF-8’。
IE兼容模式
注:在移动端不需要考虑此处
用 <meta>
标签可以指定页面应该用什么版本的IE来渲染;
如果你想要了解更多,请点击这里;
不同doctype在不同浏览器下会触发不同的渲染模式(这篇文章总结的很到位)
|
|
引入CSS, JS
根据HTML5规范, 通常在引入CSS和JS时不需要指明 type
,因为 text/css
和 text/javascript
分别是他们的默认值。
HTML5 规范链接
|
|
属性顺序
属性应该按照特定的顺序出现以保证易读性;
- class
- id
- name
- data-*
- src, for, type, href, value , max-length, max, min, pattern
- placeholder, title, alt
- aria-*, role
- required, readonly, disabled
class是为高可复用组件设计的,所以应处在第一位;
id更加具体且应该尽量少使用,所以将它放在第二位。
|
|
boolean属性
boolean属性指不需要声明取值的属性,XHTML需要每个属性声明取值,但是HTML5并不需要;
更多内容可以参考 WhatWG section on boolean attributes:
boolean属性的存在表示取值为true,不存在则表示取值为false。
|
|
JS生成标签
在JS文件中生成标签让内容变得更难查找,更难编辑,性能更差。应该尽量避免这种情况的出现。
减少标签数量
在编写HTML代码时,需要尽量避免多余的父节点;
很多时候,需要通过迭代和重构来使HTML变得更少。
|
|
实用高于完美
尽量遵循HTML标准和语义,但是不应该以浪费实用性作为代价;
任何时候都要用尽量小的复杂度和尽量少的标签来解决问题。