首页
学习
活动
专区
工具
TVP
发布
社区首页 >问答首页 >node.js应用程序的编码风格指南?

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

Stack Overflow用户
提问于 2011-03-31 14:21:43
回答 7查看 52.8K关注 0票数 133

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

我正在寻找一本(或几本)类似于PEP 8的指南,Python的规范编码风格指南。我见过许多不值得在这里链接的JavaScript指南(大多数是旧的,针对客户端JavaScript的)。我发现了一个有趣的node.js style guide

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

函数代码布局:缩进(2个空格,4个空格,制表符,...),换行符,换行符,etc.

  • Whitespace,,例如“ (arg)”vs. "function(arg)"
  • Semicolon或没有分号,var声明,...
  • 命名,例如do_this() vs. doThis(),var_name vs. varName,...
  • node.js和JavaScript惯用法,例如== vs. ===,callback的第一个arg是一个错误对象,...
  • 注释和documentation
  • Accompanying工具,如lint检查器,单元测试框架,...

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

EN

回答 7

Stack Overflow用户

回答已采纳

发布于 2011-03-31 17:04:45

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

您还可以查看著名的Node.JS程序员所使用的样式:

我将在那里使用throw mine ;)

编辑:来自@alienhard的建议

我有一些你应该遵循的金科玉律:

  • 切勿在==
  • Always上使用witheval
  • Use ===在适当的作用域中使用var声明您的变量-不要退回到全局作用域
  • 如果您计划发布在服务器端和==
  • Always中运行的代码,请将您的应用程序包装在闭包(function(){})()中应将err作为第一个参数,如果它们本身采用回调作为参数,则应该是最后一个,例如

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

票数 123
EN

Stack Overflow用户

发布于 2015-03-10 08:17:21

镇上有了新的标准。

使用Standard Style

票数 19
EN

Stack Overflow用户

发布于 2011-03-31 17:06:01

您可以从面向客户端的JavaScript指南中学到许多良好的编码风格实践(它们中的大多数也适用于node.js,因为客户端和服务器端之间的差异主要在于库,而不是语言本身)。例如,这本书专门介绍了Chapter 2的某些部分。另外,Douglas Crockford的websitebookvideos是采用JavaScript特定编码风格和最佳实践的必看资料。

票数 10
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/5495984

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档