JavaScript命名约定

Question

我知道有很多争议(可能没有争议,但至少是争论)关于哪种命名约定最适合JavaScript.

如何命名变量,函数,对象等？

我会对此有所了解,因为我没有长时间使用JS(几年,只有),我只是请求创建一个具有命名约定的文档,以便在我们的工作项目中使用.所以我一直在寻找(google-ing),并且有很多不同的意见.

我在JS上阅读的书籍本身也使用不同的命名约定,但他们都同意一点:"找到适合你的东西,并坚持下去."但是现在我已经阅读了很多,我发现我像其他一些方法一样,比我现在习惯的要好一些.

Answer 1

我遵循道格拉斯克罗克福德的 javascript 代码约定.我还使用他的JSLint工具来验证遵循这些约定.

Answer 2

正如杰夫所说,克罗克福德说的很好.

我遵循的唯一例外(并且已经广泛使用)是使用$ varname来表示jQuery(或任何库)对象.例如

var footer = document.getElementById('footer');

var $footer = $('#footer');

Answer 3

您可以按照此Google JavaScript样式指南进行操作

一般来说,使用functionNamesLikeThis,variableNamesLikeThis,ClassNamesLikeThis,EnumNamesLikeThis,methodNamesLikeThis和SYMBOLIC_CONSTANTS_LIKE_THIS.

编辑:查看JavaScript样式指南和美化师的精彩集合.

Answer 4

我想尝试的一个约定是使用'the'前缀命名静态模块.看一下这个.当我使用别人的模块时,不容易看出我应该如何使用它.例如:

define(['Lightbox'],function(Lightbox) {
  var myLightbox = new Lightbox() // not sure whether this is a constructor (non-static) or not
  myLightbox.show('hello')
})

我正在考虑尝试一种惯例,其中静态模块使用'the'来表示它们的预先存在.有没有人见过比这更好的方法？看起来像这样:

define(['theLightbox'],function(theLightbox) {
  theLightbox.show('hello') // since I recognize the 'the' convention, I know it's static
})

Answer 5

我认为除了一些语法限制; 命名约定推理与语言无关.我的意思是,支持c_style_functions和JavaLikeCamelCase的论据同样可以使用相反的方式,只是语言用户倾向于遵循语言作者.

话虽如此,我认为大多数图书馆都倾向于大致遵循Java的CamelCase的简化.我发现道格拉斯·克罗克福德对我来说很有品味.