节点.js应用的编码风格指南?[已关闭]

2022-08-30 04:21:06

是否有针对 node.js 的(或多个)编码风格指南?如果没有,顶级开源节点项目使用的新兴风格是什么?

我正在寻找一个指南(或几个指南),类似于PEP 8,Python的规范编码风格指南。我见过各种JavaScript指南不值得在这里链接(主要是旧的,针对客户端JavaScript)。我发现了一个有趣的节点.js风格指南

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

  • 代码布局:缩进(2 个空格、4 个空格、制表符等)、换行符、换行符等。
  • 空格,例如,“function (arg)” vs. “function(arg)”
  • 分号或无分号,var 声明,...
  • 命名,例如,do_this() vs. doThis(), var_name vs. varName, ...
  • node.js和JavaScript习语,例如==vs. ===,回调的第一个arg是一个错误对象,...
  • 注释和文档
  • 随附的工具,如lint checker,单元测试框架,...

这个话题显然是高度主观的,但我认为这是一个社区在成熟过程中建立一种共同的和被广泛接受的编码风格的重要一步。此外,这不仅仅是关于味道。特别是,像“使用===而不是==”这样的规则对代码质量有直接的影响。


答案 1

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

您还可以查看著名的Node.JS编码人员使用的样式:

我会把我的扔在那里,以达到很好的衡量标准;)

编辑:来自@alienhard的建议

国际海事组织(IMO)有一些你应该遵循的黄金法则:

  • 切勿使用或witheval
  • 过度使用=====
  • 始终在适当的作用域中声明变量 - 不要回退到全局作用域var
  • 如果你计划发布在服务器端和浏览器中运行的代码,请将你的应用包装在闭包中(function(){})()
  • 回调应该作为第一个参数,如果它们自己将回调作为参数,它应该是最后一个,例如errcallback(err, param1, param2, callback)

缩进、大括号和关键字之间的间距以及分号位置都是首选问题。


答案 2

镇上有一个新的标准。

使用标准样式

js-standard-style