“静态”类或模块的JavaScript命名约定?

时间:2015-04-09 08:23:21

标签: javascript coding-style naming-conventions jsdoc

根据Google's JavaScript style guide,课程应以大写字母开头。但是,JSDoc支持使用@static标记,该标记断言您不需要实例化该类以使用成员。

我有一个完全由静态函数和属性组成的类/模块。

是否应将其命名为namespaceBar.MyFooClassnamespaceBar.myFooClass

2 个答案:

答案 0 :(得分:1)

作为评论者Barmar指出here,如果您使用Math作为示例,即使不会实例化您的类/模块名称也似乎是规范的。

一个好的一般准则似乎是在命名空间提供单个“模块”功能时,将其大写,“静态”或不是。

EG。
myFooNamespace.MyBarClass - 可以实例化的类 myFooNamespace.MyBazModule - “静态”类或模块。 myFooNamespace.MyBazModule.myBarFoo() - 模块中的一个功能。 myFooNamespace.MyBazModule.myQuxBaz = "foobar" - 模块中的属性。 myFooNamespace.myQuxNamespace - 命名空间中的命名空间。

答案 1 :(得分:-1)

从我的角度来看,类和顶级命名空间应该以大写字符和变量或函数(不是类的构造函数)开头,并使用小写。所以在你的例子中

NamespaceBar.myFooNamespace

并且如评论中所指出的那样,我将其标记为命名空间,而不是标记为类。