# no-underscore-dangle

禁止标识符中的悬空下划线

就标识符的命名约定而言，悬空下划线可能是 JavaScript 中最极端的。悬空下划线是标识符开头或结尾的下划线，例如：

var _foo;

实际上，在 JavaScript 中使用悬空下划线来指示对象的 "private" 成员实际上由来已久（尽管 JavaScript 没有真正的私有成员，但这种约定是一种警告）。这始于 SpiderMonkey 添加非标准方法，例如 __defineGetter__()。带有下划线的目的是为了表明这种方法在某些方面是特殊的。从那时起，使用单个下划线前缀作为一种表示对象的 "private" 成员的方式变得流行起来。

您是否选择允许在标识符中使用悬空下划线纯粹是一种约定，对性能、可读性或复杂性没有影响。这纯粹是一种偏好。

# 规则详情

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

此规则的错误代码示例：

/*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;
function foo(_bar) {};
const foo = { onClick(_bar) {} };
const foo = (_bar) => {};

# 选项

此规则有一个对象选项：

"allow" 允许指定的标识符有悬空下划线
"allowAfterThis": false（默认）不允许在 this 对象的成员中使用悬空下划线
"allowAfterSuper": false（默认）不允许在 super 对象的成员中使用悬空下划线
"allowAfterThisConstructor": false（默认）不允许在 this.constructor 对象的成员中使用悬空下划线
"enforceInMethodNames": false（默认）允许在方法名中使用悬空下划线
"enforceInClassFields": false（默认）允许在 es2022 类字段名称中使用悬空下划线
"allowFunctionParams": true（默认）允许在函数参数名称中使用悬空下划线

# 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();

# allowAfterThisConstructor

此规则使用 { "allowAfterThisConstructor": true } 选项的正确代码示例：

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

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

# enforceInMethodNames

此规则使用 { "enforceInMethodNames": true } 选项的错误代码示例：

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

class Foo {
  _bar() {}
}

class Foo {
  bar_() {}
}

const o = {
  _bar() {}
};

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

# enforceInClassFields

此规则使用 { "enforceInClassFields": true } 选项的错误代码示例：

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

class Foo {
    _bar;
}

class Foo {
    _bar = () => {};
}

class Foo {
    bar_;
}

class Foo {
    #_bar;
}

class Foo {
    #bar_;
}

# allowFunctionParams

此规则使用 { "allowFunctionParams": false } 选项的错误代码示例：

/*eslint no-underscore-dangle: ["error", { "allowFunctionParams": false }]*/

function foo (_bar) {}
function foo (_bar = 0) {}
function foo (..._bar) {}

const foo = function onClick (_bar) {}
const foo = function onClick (_bar = 0) {}
const foo = function onClick (..._bar) {}

const foo = (_bar) => {};
const foo = (_bar = 0) => {};
const foo = (..._bar) => {};

# 何时不使用

如果您想在标识符中允许悬挂下划线，那么您可以安全地关闭此规则。

← no-undefined no-unneeded-ternary →