no-underscore-dangle

就标识符的命名约定而言，悬挂下划线可能是 JavaScript 中最具偏见的。悬挂下划线在标识符的开头或末尾是下划线，例如：

var _foo;

实际上，使用悬挂下划线表示 JavaScript 中对象的“私有”成员的历史悠久（尽管 JavaScript 没有真正的私有成员，此惯例作为警告）。这开始于 SpiderMonkey 添加非标准方法，如__defineGetter__()。下划线的意图是明显地表明这种方法在某些方面是特殊的。从那时起，使用单个下划线前缀作为指示对象的“私人”成员的方式已经变得流行。

无论您是否选择在标识符中允许悬挂下划线，都纯粹是一种约定，并且不会影响性能，可读性或复杂性。这纯粹是一种偏好。

规则细节

此规则不允许在标识符中使用悬空下划线。

此规则的错误代码示例：

/*eslint no-underscore-dangle: "error"*/

var foo_;
var __proto__ = {};
foo._bar();

此规则的正确代码示例：

/*eslint no-underscore-dangle: "error"*/

var _ = require('underscore');
var obj = _.contains(items, item);
obj.__proto__ = {};
var file = __filename;

选项

该规则有一个对象选项：

• "allow" 允许指定的标识符具有悬挂下划线

• "allowAfterThis": false（默认值）不允许在this对象的成员中使用悬挂下划线

• "allowAfterSuper": false（默认值）不允许在super对象的成员中使用悬挂下划线

• "enforceInMethodNames": false （默认）允许在方法名称中使用下划线

allow

此规则的附加正确代码示例包含以下{ "allow": ["foo_", "_bar"] }选项：

/*eslint no-underscore-dangle: ["error", { "allow": ["foo_", "_bar"] }]*/

var foo_;
foo._bar();

allowAfterThis

此规则的正确代码示例包含以下{ "allowAfterThis": true }选项：

/*eslint no-underscore-dangle: ["error", { "allowAfterThis": true }]*/

var a = this.foo_;
this._bar();

allowAfterSuper

此规则的正确代码示例包含以下{ "allowAfterSuper": true }选项：

/*eslint no-underscore-dangle: ["error", { "allowAfterSuper": true }]*/

var a = super.foo_;
super._bar();

enforceInMethodNames

此规则的错误代码示例包含以下{ "enforceInMethodNames": true }选项：

/*eslint no-underscore-dangle: ["error", { "enforceInMethodNames": true }]*/

class Foo {
  _bar() {}
}

class Foo {
  bar_() {}
}

const o = {
  _bar() {}
};

const o = {
  bar_() = {}
};

何时不使用它

如果你想在标识符中允许悬挂下划线，那么你可以放心地关闭这个规则。

版本

该规则在 ESLint 0.0.9中引入。

资源

• Rule source

• Documentation source