node.js应用的编码风格指南?

是否有一个(或几个)node.js的编码风格指南? 如果不是,那么最热门的开源节点项目使用哪些新兴的样式

我正在寻找PEP 8(Python的标准编码风格指南)的指南(或几个指南)。 我已经看到各种JavaScript指南在这里不值得链接(大多数是旧的,针对客户端JavaScript)。 我找到了一个有趣的node.js风格指南。

编码风格指南或编码规范应包括(但不限于):

  • 代码布局:缩进(2个空格,4个空格,制表符,...),换行符,换行符等
  • 空格,例如“功能(arg)”与“功能(arg)”
  • 分号或无分号,var声明,...
  • 命名,例如,do_this()与doThis(),var_name与varName,...
  • node.js和JavaScript成语,例如,==对===,回调的第一个参数是一个错误对象,...
  • 评论和文件
  • 陪同工具,如皮棉检查器,单元测试框架,...
  • 这个主题显然是非常主观的,但我认为这是社区在成熟过程中建立一种共同的,被广泛接受的编码风格的重要一步。 另外,这不仅仅是品味。 特别是像“使用===而不是==”这样的规则会直接影响代码质量。


    我会回顾由JSLint检查的编码标准,或者查看NPM(Isaac Shlueter's)编码标准的作者。

    您还可以看看着名的Node.JS编码器使用的样式:

  • TJ Holowaychuk
  • 艾萨克Shlueter
  • 蒂姆Caswell
  • 杰里米阿什肯纳斯
  • FelixGeisendörfer
  • 查理罗宾斯
  • Marak Squires
  • 亚伦赫克曼
  • 吉列尔莫劳奇
  • 迈克尔罗杰斯
  • 瑞恩达尔+你可以看看实际的Node.JS代码库
  • 我会把它扔在那里,以便采取好的措施;)

    编辑:@alienhard的建议

  • Google JavaScript风格指南
  • Felix的Node.js风格指南
  • 国际海事组织有一些你应该遵循的黄金法则:

  • 切勿使用witheval
  • 使用===覆盖==
  • 总是在合适的范围内用var声明你的变量 - 不要回退到全局范围
  • 如果您计划发布运行服务器端以及浏览器的代码,则将您的应用封装在闭包中(function(){})()
  • 回调函数应该是err作为第一个参数,如果他们自己将回调函数作为参数,它应该是最后一个,例如callback(err, param1, param2, callback)
  • 缩进,大括号和关键字之间的间隔以及分号放置都是优先选择的问题。


    镇上有一个新的标准。

    使用标准样式。


    您可以从面向客户端的JavaScript指南中学习很多良好的代码风格实践(其中大部分也适用于node.js,因为客户端和服务器端之间的差别主要在于库而不是语言本身)。 例如,JavaScript模式书专门讨论了这一主题的第2章的一些部分。同样道格拉斯克罗克福德的网站,图书和视频也是必须看到的材料,以便采用JavaScript特定的编码风格和最佳实践。

    链接地址: http://www.djcxy.com/p/2777.html

    上一篇: Coding Style Guide for node.js apps?

    下一篇: How can I remove a style added with .css() function?