Node编码规范
1. 缩进
采用2个空格缩进，而不是tab缩进。空格在编辑器中与字符是等宽的，而tab可能因编辑器的设置不同。2个空格会让代码看起来紧凑、明快。
2. 变量声明
永远用var声明变量，不加var时会将其变为全局变量，这样可能会意外污染上下文，或是被意外污染。在ecmascript5的scrict模式下，未声明的变量将会直接抛出referenceerror异常。
需要说明的是，每行声明都应该带上var，而不是只有一个var，示例代码如下；
1 var assert = require('assert');
2 var fork = require('child_process').fork;
3 var net = require('net');
4 var eventemitter = require('events').eventemitter;
错误的示例如下所示：
1 var assert = require('assert')
2 , fork = require('child_process').fork
3 , net = require('net')
4 , eventemitter = require('events').eventemitter;
3. 空格
在操作符前后需要加空格，比如 +、-、*、%、=等操作符前后都应该存在一个空格，示例如下：
1 var foo = 'bar' + baz;
错误的示例如下所示：
1 var foo='bar'+baz;
此外，在小括号的前后应该存在空格，如：
1 if (true) {
2 // some code
3 }
错误的示例如下所示：
1 if(true){
2 // some code
3 }
4. 单双引号的使用
由于双引号在别的场景下使用较多，在node中使用字符串时尽量使用单引号，这样无需转义，如：
1 var html = '<a href="http://cnodejs.org">cnode</a>';
而在json中，严格的规范是要求字符串用双引号，内容中出现双引号时，需要转义。
5. 大括号的位置
一般情况下，大括号无需另起一行，如
1 if (true) {
2 // some code
3 }
错误的示例如下所示：
1 if (true)
2 {
3 // some code
4 }
6. 逗号
逗号用于变量声明的分割或是元素的分割。如果逗号不在行结尾，前面需要一个空格。此外逗号不允许出现在行首，比如：
var foo = 'hello', bar = 'world'; // 或是 var hello = { foo:
'hello', bar: 'world' }; // 或是 var world = ['hello', 'world'];
错误的示例如下所示：
1 var foo = 'hello'
2 , bar = 'world';
3 // 或是
4 var hello = {foo: 'hello'
5 , bar: 'world'
6 };
7 // 或是
8 var world = [
9 'hello'
10 , 'world'
11 ];
7. 分号
给表达式结尾加根号。尽管javascript编译器会自动给行尾添加分号，但还是会带来一些误解，示例如下：
1 function add() {
2 var a = 1, b = 2
3 return
4 a + b
5 }
将会得到undefined的返回值。因为自动加入分号会变成如下的样式：
1 function add() {
2 var a = 1, b = 2;
3 return;
4 a + b;
5 }
后续的a + b将不会执行。
而如下的代码：
x = y
(function () {
}())
// 执行时会得到
x = y(function () {}())
由于自动添加分号可能会带来未预期的结果，所以添加上分号有助于避免误会。
命名规范
在编码过程中，命名是重头戏。好的命名可以令代码赏心悦目，带来愉悦的阅读享受，令代码具有良好的可维护性。命令的主要范畴有变量、常量、方法、类、文件、包等。
1. 变量命名
变量名都采用小驼峰式命名，即除了第一个单词的首字母不大写外，每个单词的首字母都大写，词与词之间没有任何特殊符号，如：
1 var adminuser = {};
错误的示例如下：
1 var admin_user = {};
2. 方法命名
方法命名与变量命名一样，采用小驼峰式命名。与变量不同的是，方法名尽量采用动词或判断行词汇，如：
1 var getuser = function () {};
2 var isadmin = function () {};
3 user.prototype.getinfo = function () {};
错误的示例如下：
1 var get_user = function () {};
2 var is_admin = function () {};
3 user.prototype.get_info = function () {};
3. 类命名
类名采用大驼峰式命名，即所有单词的首字母都大写，如：
1 function user(){
2 }
4. 常量命名
作为常量时，单词的所有字母都大写，并用下划线分割，如：
1 var pink_color = "pink";
5. 文件命名
命名文件时，请尽量采用下划线分割单词，比如child_process.js和string.decode.js。如果你不想将文件暴露给其他用户，可以约定以下划线开头，如_linklist.js
6. 包名
如果你有贡献模块并将其打包发布到npm上。在包名中，尽量不要包含js或node的字样，它是重复的。包名应当适当短且有意义的，如：
1 var express = require('express');
比较操作
在比较操作中，如果是无法容忍的场景，请尽量使用 === 代替 ==，否则你会遇到下面这河阳不符合逻辑的结果：
1 '0' == 0; // true 2 '' == 0 // true 3 '0' === '' // false
此外，当判断容忍假值时，可以无需使用 === 或 ==。在下面的代码中，当foo是0、undefined、null、false、‘ ’ 时，都会进入分支：
1 if (!foo) {
2 // some code
3 }
字面量
请尽量使用{}、[]代替new object()、new array(),不要使用string、bool、number对象类型，即不要使用new string、new boolean 和 new number。
作用域
在javascript中，需要注意一个关键字和一个方法，它们是with和eval()，容易引起作用域混乱。
1. 慎用with
示例代码如下：
1 with (obj) {
2 foo = bar;
3 }
它的结果有可能是如下四种之一：obj.foo = obj.bar; 、obj.foo = bar;、 foo = bar;、 foo = obj.bar;，这些结果取决于它的作用域。如果作用域链上没有导致冲突的变量存在，使用它则是安全的。但在多人合作的项目中，这并不能保证，所以要慎用with。
2. 慎用eval
数组与对象
在javascript中，数组其实也是独享，但是两者在使用时有些细节需要注意。
1.字面量格式
创建对象或者数组时，注意在结尾用逗号分隔。如果分行，一行只能一个元素，示例代码如下：
1 var foo = ['hello', 'world'];
2 var bar = {
3 hello: 'world',
4 pretty: 'code'
5 };
错误示例如下所示：
1 var foo = ['hello',
2 'world'];
3 var bar = {
4 hello: 'world', pretty: 'code'
5 };
2.for in 循环
使用for in循环时，请对对象使用，不要对数组使用，示例代码如下：
1 var foo = [];
2 foo[100] = 100;
3 for (var i in foo) {
4 console.log(i);
5 }
6 for (var i = 0; i < foo.length; i++) {
7 console.log(i);
8 }
在上述代码中，第一个循环只打印一次，而第二个循环则打印0~100，这并不满足预期的值。
3.不要把数组当做对象使用
尽管在javascript内部实现中可以把数组当做对象来使用，如下所示：
1 var foo = [1, 2, 3];
2 foo['hello'] = 'world';
3 这在for in迭代时，会得到所有值
4 for (var i in foo) {
5 console.log(foo[i]);
6 }
7 也许你只是想得到hellow而已。
异步
在node中，异步使用非常广泛并且在实践过程中形成了一些约定，这是以往不曾在意的点。
1.异步回调函数的第一个参数应该是错误指示
并不是所有的回调函数都需要将第一个参数设计为错误对象，但是一旦涉及异步，将会导致try catch无法捕获到异步回调期的异常。将第一个参数设计为错误对象，告知调用方是一个不错的约定。示例代码如下。
1 function(err, data){
2 };
这个约定被很多流程控制库所采用。遵循这个约定，可以享受社区流程控制库带来的业务编写遍历。
2.执行传入的回调函数
在异步方法中一旦有回调函数传入，就一定要执行它，且不能多次执行。如果不执行，可能造成调用一直等待不结束，多次执行也可能会造成未预期的结果。
类与模块
关于如何在javascript中实现继承，有各种各样的方式，但在node中我们只推荐一种，那就是类继承的方式。另外，在node中，如果要将一个类作为一个模块，就需要在意它的导出方式。
1.类继承
一般情况下，我们采用node推荐的类继承方式，示例代码如下：
1 function socket(options) {
2 // ...
3 stream.stream.call(this);
4 // ...
5 }
6 util.inherits(socket, stream.stream);
-
导出
所有供外部调用的方法或变量均需挂载在exports变量上。当需要将文件做一个类导出时，需要通过如下的方式挂载：
1 module.exprots = class;
而不是通过
1 exports = class;
私有方法无需因为测试等原因导出给外部，所以无需挂载。
注释详解
一般情况下，我们会对每个方法编写注释，这里采用dox的推荐注释，示例如下：
1 /**
2 * queries some records
3 * examples:
4 * ```
5 * query('select * from table', function (err, data) {
6 * // some code
7 * });
8 * ```
9 * @param {string} sql queries
10 * @param {function} callback callback
11 */
12 exports.query = function (sql, callback) {
13 // ...
14 };
dox的注释规范来自与jsdoc。可以通过注释生成对应的api文档。
本文摘抄自 朴灵的深入浅出node.js一书，感觉还不错，在此分享。
上一篇： Frangi形态学滤波详解