我经常看到JavaScript中以美元符号开头的变量。什么时候/为什么选择以这种方式为变量加上前缀?

(我不是问你在jQuery和其他中看到的$('p.foo')语法,而是像$name和$order这样的正常变量)


当前回答

有效的JavaScript标识符必须以字母开头, 下划线(_)或美元符号($); 后续字符也可以 是数字(0-9)。因为JavaScript是区分大小写的, 信 包括字母“A”到“Z”(大写)和 字母a到z(小写)。

细节: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Grammar_and_types#Variables

其他回答

由于变量名开头的_通常用于表示一个私有变量(或至少是一个私有变量),我发现$方便在我自己的简短别名前面添加到泛型代码库。

例如,在使用jQuery时,我更喜欢使用变量$J(而不是仅仅$),在使用php.js时使用$P,等等。

前缀使它在视觉上与其他变量(如我自己的静态变量)不同,提示我代码是某个库或其他库的一部分,一旦他们知道了约定,就不太可能与他人冲突或混淆。

它也不会像对每个库调用重复完全指定的名称那样使代码变得混乱(或需要额外的输入)。

我喜欢把它看作是类似于修饰键扩展单键可能性的作用。

但这只是我自己的习惯。

jQuery中最常见的用法是将存储在变量中的jQuery对象与其他变量区分开来。

例如,我会定义:

var $email = $("#email"); // refers to the jQuery object representation of the dom object
var email_field = $("#email").get(0); // refers to the dom object itself

我发现这在编写jQuery代码时非常有帮助,并且可以很容易地看到具有不同属性集的jQuery对象。

在AngularJS的上下文中,$前缀只用于框架代码中的标识符。框架的用户被告知不要在自己的标识符中使用它:

Angular命名空间$和$$ 为了防止与你的代码发生意外的名称冲突,Angular会在公共对象的名称前加上$,在私有对象的名称前加上$$。请不要在代码中使用$或$$前缀。

来源:https://docs.angularjs.org/api

虽然您可以简单地使用它作为标识符的前缀,但它应该用于生成的代码,例如模板中的替换令牌。

早在2006年,我就发起了这个惯例,并在早期的jQuery邮件列表中推广它,所以让我分享一些关于它的历史和动机。

公认的答案给出了这样一个例子:

var $email = $("#email"); // refers to the jQuery object representation of the dom object
var email_field = $("#email").get(0); // refers to the dom object itself

但这并没有很好地说明它。即使没有$,我们仍然有两个不同的变量名,email和email_field。这已经足够好了。当我们已经有两个不同的名称时,为什么还要在其中一个名称中添加$呢?

实际上,我在这里没有使用email_field,原因有两个:names_with_下划线不是惯用的JavaScript, field对于DOM元素没有实际意义。但我也有同样的想法。

我尝试了一些不同的东西,其中一些东西与这个例子非常相似:

var email = $("#email"), emailElement = $("#email")[0];
// Now email is a jQuery object and emailElement is the first/only DOM element in it

(当然,一个jQuery对象可以有多个DOM元素,但我正在处理的代码有很多id选择器,所以在这些情况下有1:1的对应关系。)

我有另一个例子,一个函数接收一个DOM元素作为参数,也需要一个jQuery对象:

// email is a DOM element passed into this function
function doSomethingWithEmail( email ) {
    var emailJQ = $(email);
    // Now email is the DOM element and emailJQ is a jQuery object for it
}

这有点让人困惑!在我的一段代码中,email是jQuery对象,emailElement是DOM元素,但在另一段代码中,email是DOM元素,emailJQ是jQuery对象。

没有一致性,我一直把它们混在一起。另外,必须为同一事物创建两个不同的名称有点麻烦:一个用于jQuery对象,另一个用于匹配的DOM元素。除了email、emailElement和emailJQ,我还一直在尝试其他变体。

然后我注意到一个常见的模式:

var email = $("#email");
var emailJQ = $(email);

由于JavaScript仅仅把$当作另一个字母来表示名称,而且我总是从$(无论什么)调用中返回一个jQuery对象,所以我终于明白了这个模式。我可以使用$(…)调用并删除一些字符,它会产生一个非常不错的名称:

$("#email")
$(email)

三振出局并不完美,但你可能会明白:删除了一些字符,这两行最终看起来像:

$email

这时我意识到我不需要编写emailElement或emailJQ这样的约定。已经有一个很好的约定在盯着我:从$(whatever)调用中取出一些字符,它就会变成$whatever。

var $email = $("#email"), email = $email[0];
// $email is the jQuery object and email is the DOM object

and:

// email is a DOM element passed into this function
function doSomethingWithEmail( email ) {
    var $email = $(email);
    // $email is the jQuery object and email is the DOM object
    // Same names as in the code above. Yay!
}

所以我不需要总是编造两个不同的名字,而是可以使用相同的名字,带或不带$前缀。$前缀是一个很好的提醒,我正在处理一个jQuery对象:

$('#email').click( ... );

or:

var $email = $('#email');
// Maybe do some other stuff with $email here
$email.click( ... );