赞助商

Node编码规范

发布时间:2019-03-18 发布网站:脚本之家
脚本之家收集整理的这篇文章主要介绍了Node编码规范脚本之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。

<h2 class="md-end-block md-heading md-focus"><span class="md-expand">编码规范
<h3 class="md-end-block md-heading">1. 缩进

采用2个空格缩进,而不是tab缩进。空格在编辑器中与字符是等宽的,而tab可能因编辑器的设置不同。2个空格会让代码看起来紧凑、明快。

2. 变量声明

永远用var声明变量,不加var时会将其变为全局变量,这样可能会意外污染上下文,或是被意外污染。在ECMAScript5的scrict模式下,未声明的变量将会直接抛出ReferenceError异常。

需要说明的是,每行声明都应该带上var,而不是只有一个var,示例代码如下;

assert = require('assert' fork = require('child_process' net = require('net' EventEmitter = require('events').EventEmitter;

 

错误的示例如下所示:

assert = require('assert',fork = require('child_process',net = require('net',EventEmitter = require('events').EventEmitter;

3. 空格

  在操作符前后需要加空格,比如 +、-、*、%、=等操作符前后都应该存在一个空格,示例如下:

foo = 'bar' + baz;

  错误的示例如下所示:

foo='bar'+baz;

  此外,在小括号的前后应该存在空格,如:

( }

  错误的示例如下所示:

( }

 

4. 单双引号的使用

  由于双引号在别的场景下使用较多,在Node中使用字符串时尽量使用单引号,这样无需转义,如:

html = '';

而在JSON中,严格的规范是要求字符串用双引号,内容中出现双引号时,需要转义。

5. 大括号的位置

  一般情况下,大括号无需另起一行,如

( }

  错误的示例如下所示:

( }

6. 逗号

  逗号用于变量声明的分割或是元素的分割。如果逗号不在行结尾,前面需要一个空格。此外逗号不允许出现在行首,比如:

foo = 'hello',bar = 'world'; 'hello',bar: 'world' };

  错误的示例如下所示:

foo = 'hello' ,bar = 'world' hello = {foo: 'hello' ,bar: 'world' world = 'hello' ,'world' ];

7. 分号

  给表达式结尾加根号。尽管Javascript编译器会自动给行尾添加分号,但还是会带来一些误解,示例如下:

a = 1,b = 2 a + }

  将会得到undefined的返回值。因为自动加入分号会变成如下的样式:

a = 1,b = 2 a + }

  后续的a + b将不会执行。

  而如下的代码:

x = x = y( () {}())

  由于自动添加分号可能会带来未预期的结果,所以添加上分号有助于避免误会。

命名规范

  在编码过程中,命名是重头戏。好的命名可以令代码赏心悦目,带来愉悦的阅读享受,令代码具有良好的可维护性。命令的主要范畴有变量、常量、方法、类、文件、包等。

1. 变量命名

  变量名都采用小驼峰式命名,即除了第一个单词的首字母不大写外,每个单词的首字母都大写,词与词之间没有任何特殊符号,如:

adminUser = {};

  错误的示例如下:

admin_user = {};

2. 方法命名

  方法命名与变量命名一样,采用小驼峰式命名。与变量不同的是,方法名尽量采用动词或判断行词汇,如:

getUser = isAdmin = User.prototype.getInfo = () {};

  错误的示例如下:

get_user = is_admin = User.prototype.get_info = () {};

3. 类命名

  类名采用大驼峰式命名,即所有单词的首字母都大写,如:

}

4. 常量命名

  作为常量时,单词的所有字母都大写,并用下划线分割,如:

PINK_COLOR = "pink";

5. 文件命名

  命名文件时,请尽量采用下划线分割单词,比如child_process.js和string.decode.js。如果你不想将文件暴露给其他用户,可以约定以下划线开头,如_linklist.js

6. 包名

  如果你有贡献模块并将其打包发布到NPM上。在包名中,尽量不要包含js或node的字样,它是重复的。包名应当适当短且有意义的,如:

express = require('express');

比较操作

  在比较操作中,如果是无法容忍的场景,请尽量使用 === 代替 ==,否则你会遇到下面这河阳不符合逻辑的结果:

'0' == 0; '' == 0 '0' === ''

  此外,当判断容忍假值时,可以无需使用 === 或 ==。在下面的代码中,当foo是0、undefined、null、false、‘ ’ 时,都会进入分支:

(! }

字面量

  请尽量使用{}、[]代替new Object()、new Array(),不要使用string、bool、number对象类型,即不要使用new String、new Boolean 和 new Number。

作用域

  在JavaScript中,需要注意一个关键字和一个方法,它们是with和eval(),容易引起作用域混乱。

1. 慎用with

  示例代码如下:

foo = }

  它的结果有可能是如下四种之一:obj.foo = obj.bar; 、obj.foo = bar;、 foo = bar;、 foo = obj.bar;,这些结果取决于它的作用域。如果作用域链上没有导致冲突的变量存在,使用它则是安全的。但在多人合作的项目中,这并不能保证,所以要慎用with。

2. 慎用eval

 

数组与对象

在JavaScript中,数组其实也是独享,但是两者在使用时有些细节需要注意。

1.字面量格式

  创建对象或者数组时,注意在结尾用逗号分隔。如果分行,一行只能一个元素,示例代码如下:

foo = ['hello','world' bar = hello: 'world' pretty: 'code' };

  错误示例如下所示:

foo = ['hello' 'world' bar = hello: 'world',pretty: 'code' };

2.for in 循环

  使用for in循环时,请对对象使用,不要对数组使用,示例代码如下:

foo = foo[100] = 100 ( i ( i = 0; i < foo.length; i++ }

在上述代码中,第一个循环只打印一次,而第二个循环则打印0~100,这并不满足预期的值。

3.不要把数组当做对象使用

  尽管在JavaScript内部实现中可以把数组当做对象来使用,如下所示:

foo = [1,2,3 foo['hello'] = 'world' ( i 也许你只是想得到hellow而已。

异步

在Node中,异步使用非常广泛并且在实践过程中形成了一些约定,这是以往不曾在意的点。

1.异步回调函数的第一个参数应该是错误指示

  并不是所有的回调函数都需要将第一个参数设计为错误对象,但是一旦涉及异步,将会导致try catch无法捕获到异步回调期的异常。将第一个参数设计为错误对象,告知调用方是一个不错的约定。示例代码如下。

};

这个约定被很多流程控制库所采用。遵循这个约定,可以享受社区流程控制库带来的业务编写遍历。

2.执行传入的回调函数

  在异步方法中一旦有回调函数传入,就一定要执行它,且不能多次执行。如果不执行,可能造成调用一直等待不结束,多次执行也可能会造成未预期的结果。

类与模块

关于如何在JavaScript中实现继承,有各种各样的方式,但在Node中我们只推荐一种,那就是类继承的方式。另外,在Node中,如果要将一个类作为一个模块,就需要在意它的导出方式。

1.类继承

 一般情况下,我们采用Node推荐的类继承方式,示例代码如下:

stream.Stream.call( util.inherits(Socket,stream.Stream);
    导出

    所有供外部调用的方法或变量均需挂载在exports变量上。当需要将文件做一个类导出时,需要通过如下的方式挂载:

module.exprots = Class;
exports = Class;

  私有方法无需因为测试等原因导出给外部,所以无需挂载。

注释详解

  一般情况下,我们会对每个方法编写注释,这里采用dox的推荐注释,示例如下:

exports.query = };

 

  dox的注释规范来自与JSDoc。可以通过注释生成对应的API文档。

  本文摘抄自 朴灵的深入浅出Node.js一书,感觉还不错,在此分享。

总结

以上是脚本之家为你收集整理的Node编码规范全部内容,希望文章能够帮你解决Node编码规范所遇到的程序开发问题。

如果觉得脚本之家网站内容还不错,欢迎将脚本之家网站推荐给程序员好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:76874919,请注明来意。
标签: