使用nodejs时的JavaScript命名约定

时间:2012-04-25 23:21:11

标签: javascript node.js naming-conventions

我在node.js中使用JavaScript工作得更多。我的应用程序具有以下使用的一般“类”。

服务器端:

  • 模型
  • 实用程序
  • 路线

客户端(backbone.js):

  • 浏览
  • 模型
  • 集合

客户端非常直接。我将所有与其相关的文件命名为UserModel.js,UserView.js,UserCollection.js等。

然而,服务器端变得更加混乱。例如:

模型与MongoDB集合相关。每个Model只是各种功能的包装器。如果我有一个用户集合,我有一个名为users的集合,我的模型是Users.js

我也有例如Users.js的库,它与模型交互并包含大部分逻辑。

然而,这真的不应该被称为Users,主要是因为我现在感到困惑。

路由只与URL相关。因此,如果您有/account/我将拥有account.js路线 - 全部为小写。

实用程序 - 我只有一个不会使用太多的util.js所以我不那么担心,命名似乎很好,因为它的目的和大小。

您如何建议命名类似“库”的通用名称,以区别于“模型/路径”。

3 个答案:

答案 0 :(得分:5)

您的命名约定中最重要的是一致性。只要它是理智且一致的,你几乎可以找出任何命名约定。

话虽如此,在这种情况下,我的名字可能会更加冗长。路径可能已经足够好了,但我希望根据您的示例看到UserRoutes.jsUserModel.js甚至UserLib.js

在我的一些node.js项目中,我甚至不使用.js扩展名。我的路线例如是user.routes。可以很容易地根据不同的扩展名更改编辑器中的语法高亮。

答案 1 :(得分:1)

助手,扩展,泛型,逻辑,存储库,经理,调解员,沟通者......其中任何一个?

我通常根据我用来实现它们的设计模式来命名。

答案 2 :(得分:0)

我实际上是在做你现在正在做的事情。我有模型,路线,视图和控制器的文件夹。然后我在每个文件夹中都有一个名为user.js的文件。当我需要修复错误或实现与用户有关的事情时,很容易找出我需要去的地方。

我认为如果我们试图为所有这些文件提供聪明的名称,而它们都在实现相关事物的不同方面,那将会令人困惑。