轩枫阁

首页 / 授人以渔 / Javascript / Node编码规范

Node编码规范

编码规范

  • 缩进,2 个 space,tab要转换成 2 space. (入乡随俗,这是Node 源码及module 采用的标准) Eclipse设置
  • 永远用 var 声明变量,不加 var 时,会污染顶层上下文
  • 操作符与操作算子之间要有空格

Right:

Wrong:

  • 使用string 时,用单引号替代双引号(写JSON 时除外)

Right:

Wrong:

  • 大括号位置

Right:

Wrong:

  • Camel 命名法

采用以下规则:

  1. 函数和变量:functionNamesLikeThis, variableNamesLikeThis,
  2. 类名和枚举类型:ClassNamesLikeThis, EnumNamesLikeThis,
  3. 类方法:methodNamesLikeThis
  4. 常量:SYMBOLIC_CONSTANTS_LIKE_THIS

Right :

Wrong:

  • 文件命名

单词之间使用 _ (underscore) 来 分割,如果你不想暴露某个文件给用户 , 你也可以用_ 来开头

Right :

  • 不使用 const 关键字 虽然V8 和 Mozilla 都支持它,但它不是ECMA 标准,我们用以下方式定义常量:

Right:

  • 比较操作 有的场景下应该用 “===” 替代 “==” 当你遇到这些符号比较时 :0 undefined null false true

你应该小心谨慎 比如 ’ \t\r\n’ == 0 比较结果是 true

Right:

Wrong:

  • 使用字面表达式,用 ‘{}’ ,'[]’ 代替 new Array ,new Object

不要使用 string,bool,number 的对象类型,即不要调用 new String ,new Boolean ,new Number

  • Object ,Array 创建,当有多个元素时,注意分行排列时逗号的位置

Right:

Wrong:

  • 避免使用 “with” 与 “eval”
  • for-in 循环,仅在 object/hash/map 时使用,绝不要对Array 使用
  • 不要把Array 当做关联数组或Object 使用,即你不应该用非数字作为Array 的索引 (Phper 尤其注意这点)

Wrong :

Right:

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

  • 类继承写法,尽管有各种方式来实现继承,但最为推荐的是Node 的标准写法

  • 如果你在模块中 exports 一个类,对于此类的私有成员变量,建议加上 “_” 前缀以示区分
  • 变量声明时,应该每行声明一个,不应该都写在一行(尽管这被JSLint 所推荐)。

Right:

Wrong:( Node 源代码已经将此方式全部修正)

Right :

更多案例请参看以上链接

  • 多参考、模仿 Node 源码的编程风格 ^_^

参考

参考自:windyrobin

本文标题:Node编码规范 - 轩枫阁

转载请务必注明出处,欢迎分享

如果觉得我的文章对您有用,请随意打赏
赞  赏
赞赏作者 轩枫-ivan
¥ 6.66
换个金额 使用微信扫一扫赞赏
  • 6.66
  • 8.88
  • 16.8
  • 2.33
  • 52.0
  • 20.0
  • 自定义
  • 10.0
135/451
137/451

相关文章

文章评论

  • test

纸飞机许愿

x

钢琴节奏

请选择弹奏的曲谱

    • 1
    • 2
    • 3
    • 4
    • 5
    • 6
    • 7
    • 1
    • 2

    [返回曲谱列表]