1.黄金法则(Golden rule)
不管有多少人参与同一个项目,一定要确保每一行代码都像是同一个人编写的。
Every line of code should appear to be written by a single person, no matter the number of contributors.
这就需要在一个项目中,我们永远遵循同一套编码规范。在项目开发前,制定一套行之有效的编码规范,每个项目组成员都要按这个规范来编码。
2.命名规范
CSS 文件名使用英文小写,多个单词时,中间用下划线(_)连接,如:index.html web-guide.html
id 命名使用英文驼峰命名法,多采用语义化来命名
自定义属性采用英文小写命名,多个单词时,中间用中划线(-)连接,如:generate-catalogue
以 data- 开始的属性名,是用来存储数据的,具体可参考 W3C Html 5 data- 。html可以通过 dataset 来取属性中的值,对于不支持的浏览器,可以通过getAttribute来获取。例如:data-city="ShangHai" ,如果对应的html标签id为 cityList,则 document.getElementById('cityList').dataset('city'); 对于不支持的浏览器,应该document.getElementById('cityList').getAttribute('-data-city');
3.书写规范
3.1 语法
使用两个空格来代替制表符(tab)作为缩进,— 这是保证代码在各种环境下显示一致的唯一方式
嵌套元素应当缩进一次(即两个空格)
对于属性中的值,确保全部使用双引号,不要使用单引号,也不要省略引号
不要在自闭合(self-closing)元素的尾部添加斜线 — HTML5 规范 中明确说明这是可选的
不要省略可选的结束标签(closing tag)(例如, 或