原文地址:http://nodeguide.com/style.html
这是翻译的关于nodejs编码风格的一片文章,nodejs并没有官方统一的编码风格,但是好的编码风格可以提高代码可读性,既然有人总结了,就可以参照一下。没有对原文进行全面的翻译,只是把该有的规则提取出来了。
1、Tab和空格
用两个空格表示缩进,而不是使用Tab
2、分号
虽然javascript可以不使用分号表示语句的结束,但是为了避免犯错,还是在一定要加上分号。
3、行宽限制
将行宽限制在80个字符之内。
4、引号
除非你在编写JSON,否则使用单引号
5、花括号
将花括号放在语句的同一行上。
6、变量声明
使用var 声明变量,每个变量后边添加分号,不要使用逗号连续声明变量。
7、变量和属性名
使用小骆峰式命名法,避免使用单字符变量和缩写。
8、类名
使用大骆峰式命名法
9、常量
全部使用大写,多个单词可以下划线连接。
10、对象和数组的创建
在尾部使用逗号。
11、判断相等操作
使用三等号===而不是双等号==,双等号会自动转换,出现意想不到的问题。
12、扩展对象
不要扩展任何对象的属性,尤其是原生对象,如果不遵守这条规则的话会出现意想不到的问题。
13、条件
任何有意义的条件都应该有一个描述的变量,例如:
14、函数名长短
函数名不要太长。
15、返回值
避免深度潜入到if语句中,争取每一个函数都尽早有个返回值。
16、闭包名字
给每个闭包添加一个命名。
17、内嵌闭包
不要过多的内嵌闭包,否则会一团乱的。
18、回调函数
由于nodejs都是非阻塞的IO操作,函数一般都是通过回调函数来返回他们的结果的。nodejs采用回调函数的第一个对象作为错误对象,自己写回调函数的使用也应该遵守这条规则。
19、getters和setters
不要使用setters,因为它会造成更多的问题,getters可以任意使用