Fork me on GitHub

node编码规范

node编码规范

一、缩进

> 两个空格缩进,而不是tab缩进

二、变量声明

> 每一行声明必须带有var

三、空格

> 在操作符前后需要加空格(+,——,*,%,=等等)。此外小括号前后要加空格
1
2
3
if (true) {
// some code
}

四、单双引号的使用

> 字符串使用单引号,json使用双引号

五、大括号的位置

> 大括号无需另起一行

六、逗号

> 逗号如果不在行尾,需要一个空格。 

1
2
3
var help = {
foo: 'hep', bar: 'me'
}

七、分号

> 给表达式结尾添加分号,不在行尾需要一个空格

八、命名规范

> 命名的主要范畴有变量,常量,方法,类,文件,包等
1、变量命名
> 采用小驼峰命名 adminUser等等
2、方法命名
> 方法名也是小驼峰法,但是采用的是动词或者判断性词语
3、类命名
> 采用大驼峰法命名 AdminUser
4、常量命名
> 单词的所有字母大写,用下划线分割
5、文件命名
> 小写,下划线分割
6、包名
> 不要包含node或者js的字样

九、比较操作

> 如果是无容忍的情况,请使用‘===’代替‘==’

十、字面量

> 使用{}【】代替new Object()和new Array(),不要调用string,bool,number对象类型。

十一、作用域

> 慎用with和eval    ·

十二、数组和对象

1、字面格式量
> 如果对象中分行,一行只能有一个元素
2、for in循环
> 请对对象使用,不要对数组使用
3、 不要把数组当做对象来使用

十二、异步

> 异步回调的第一个参数应该是错误提示
1
2
3
function (err,data){

}
> 执行传入的回调函数,不能执行多次

十三、类与模块

1、类继承
> 一般情况下,我们采用Node推荐的类继承方式
2、导出
> module.exports = Class;

十四、注解规范

> dox的注释规范。
显示 Gitment 评论