HTML:
- 用两个空格来缩进;
- 对于属性的定义,确保全部使用双引号,绝不要使用单引号;
- 不要在自闭合(self-closing)元素的尾部添加斜线,如
<img>
; - 文档编码采用 UTF-8;
- 尽量遵循HTML 标准和语义,尽量使用最少的标签并保持最小的复杂度;
- 布尔型属性可以在声明时不赋值,如
<input type="checkbox" value="1" checked>
; - HTML 属性应当按照以下给出的顺序依次排列:
- class
- id, name
- data-*
- src, for, type, href, value
- title, alt
- 尽量避免多余的父元素;
CSS:
1、十六进制值应该全部小写,且使用简写形式的十六进制值,如 #fff
;
2、避免为 0 值指定单位,例如,用 margin: 0;
3、选择器要尽可能短,并且尽量限制组成选择器的元素个数,建议不要超过3个;
4、在可以使用缩写的情况下,尽量使用属性缩写;
5、为了代码的易读性,在每个声明块的左花括号前添加一个空格,如img { margin-left: 15px } ;
6、为了获得更准确的错误报告,每条声明都应该独占一行;
7、所有声明语句都应当以分号结尾;
8、为选择器中的属性添加双引号,例如,input[type="text"]
;
9、在需要显示地设置所有值的情况下,应当尽量限制使用简写形式的属性声明;
Javascript:
1、变量名使用驼峰法来命名;
2、常量(如 PI)用大写;
3、用作代码块起始的左花括号 {
前必须有一个空格;
4、在对象创建时,属性中的:
之后必须有空格
如:
var obj = {
a: 1,
b: 2,
c: 3
};
5、函数声明、具名函数表达式、函数调用中,函数名和 (
之间不允许有空格;
6、每个独立语句结束后必须换行;
7、在函数声明、函数表达式、函数调用、对象创建、数组创建、for 语句等场景中,不允许在,或;
前换行;
8、不同行为或逻辑的语句集,使用空行隔开;
9、函数名使用动宾短语,如function queryUsers()
;
10、boolean 类型的变量使用 is
或 has
开头;
11、每个 var
或者let
只能声明一个变量;
12、使用类型严格的 ===
,仅当判断 null
或 undefined
时,允许使用 ==
null
;
13、尽量减少 DOM 操作;
14、避免回调地狱,两层以上的回调用Promise,在移动端项目中,可使用async/await
;
15、函数的注释模板如下:
/**
* 函数的功能说明
* @param1 {数据类型} 参数名1 参数说明1
* @param2 {数据类型} 参数名2 参数说明2
* @return {返回值类型} 返回值 返回值说明
*/