no-underscore-dangle

不允許在識別符號中使用尾隨底線

就識別符號的命名慣例而言，尾隨底線可能是 JavaScript 中最具爭議性的。尾隨底線是指在識別符號開頭或結尾的底線，例如

var _foo;
1

在 JavaScript 中，使用尾隨底線標記「私有」成員有很長的歷史，從 SpiderMonkey 加入非標準方法（如 __defineGetter__()）開始。自那時起，使用單一下底線前綴已成為表示成員不是物件公開介面的最流行慣例。

建議使用 ECMAScript 2022 中引入的正式私有類別特性來封裝私有資料和方法，而不是依賴命名慣例。

允許在識別符號中使用尾隨底線純粹是一種慣例，對效能、可讀性或複雜性沒有影響。即使啟用此規則，它們也不具有與私有類別特性相同的封裝優勢。

規則詳情

此規則不允許在識別符號中使用尾隨底線。

此規則的錯誤程式碼範例

在遊樂場中開啟

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

var foo_;
var __proto__ = {};
foo._bar();
1
2
3
4
5

此規則的正確程式碼範例

在遊樂場中開啟

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

var _ = require('underscore');
var obj = _.contains(items, item);
obj.__proto__ = {};
var file = __filename;
function foo(_bar) {};
const bar = { onClick(_bar) {} };
const baz = (_bar) => {};
1
2
3
4
5
6
7
8
9

選項

此規則有一個物件選項

"allow" 允許指定的識別符號具有尾隨底線
"allowAfterThis": false (預設) 不允許在 this 物件的成員中使用尾隨底線
"allowAfterSuper": false (預設) 不允許在 super 物件的成員中使用尾隨底線
"allowAfterThisConstructor": false (預設) 不允許在 this.constructor 物件的成員中使用尾隨底線
"enforceInMethodNames": false (預設) 允許在方法名稱中使用尾隨底線
"enforceInClassFields": false (預設) 允許在 es2022 類別欄位名稱中使用尾隨底線
"allowInArrayDestructuring": true (預設) 允許在陣列解構賦值的變數名稱中使用尾隨底線
"allowInObjectDestructuring": true (預設) 允許在物件解構賦值的變數名稱中使用尾隨底線
"allowFunctionParams": true (預設) 允許在函式參數名稱中使用尾隨底線

allow

具有 { "allow": ["foo_", "_bar"] } 選項時，此規則的其他正確程式碼範例

在遊樂場中開啟

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

var foo_;
foo._bar();
1
2
3
4

allowAfterThis

具有 { "allowAfterThis": true } 選項時，此規則的正確程式碼範例

在遊樂場中開啟

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

var a = this.foo_;
this._bar();
1
2
3
4

allowAfterSuper

具有 { "allowAfterSuper": true } 選項時，此規則的正確程式碼範例

在遊樂場中開啟

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

class Foo extends Bar {
  doSomething() {
    var a = super.foo_;
    super._bar();
  }
}
1
2
3
4
5
6
7
8

allowAfterThisConstructor

具有 { "allowAfterThisConstructor": true } 選項時，此規則的正確程式碼範例

在遊樂場中開啟

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

var a = this.constructor.foo_;
this.constructor._bar();
1
2
3
4

enforceInMethodNames

具有 { "enforceInMethodNames": true } 選項時，此規則的錯誤程式碼範例

在遊樂場中開啟

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

class Foo {
  _bar() {}
}

class Bar {
  bar_() {}
}

const o1 = {
  _bar() {}
};

const o2 = {
  bar_() {}
};
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

enforceInClassFields

具有 { "enforceInClassFields": true } 選項時，此規則的錯誤程式碼範例

在遊樂場中開啟

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

class Foo {
    _bar;
}

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

class Baz {
    bar_;
}

class Qux {
    #_bar;
}

class FooBar {
    #bar_;
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

allowInArrayDestructuring

具有 { "allowInArrayDestructuring": false } 選項時，此規則的錯誤程式碼範例

在遊樂場中開啟

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

const [_foo, _bar] = list;
const [foo_, ..._qux] = list;
const [foo, [bar, _baz]] = list;
1
2
3
4
5

allowInObjectDestructuring

具有 { "allowInObjectDestructuring": false } 選項時，此規則的錯誤程式碼範例

在遊樂場中開啟

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

const { foo, bar: _bar } = collection;
const { qux, xyz, _baz } = collection;
1
2
3
4

具有 { "allowInObjectDestructuring": false } 選項時，此規則的正確程式碼範例

在遊樂場中開啟

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

const { foo, bar, _baz: { a, b } } = collection;
const { qux, xyz, _baz: baz } = collection;
1
2
3
4

allowFunctionParams

具有 { "allowFunctionParams": false } 選項時，此規則的錯誤程式碼範例

在遊樂場中開啟

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

function foo1 (_bar) {}
function foo2 (_bar = 0) {}
function foo3 (..._bar) {}

const foo4 = function onClick (_bar) {}
const foo5 = function onClick (_bar = 0) {}
const foo6 = function onClick (..._bar) {}

const foo7 = (_bar) => {};
const foo8 = (_bar = 0) => {};
const foo9 = (..._bar) => {};
1
2
3
4
5
6
7
8
9
10
11
12
13

何時不使用它

如果您想允許在識別符號中使用尾隨底線，則可以安全地關閉此規則。

版本

此規則是在 ESLint v0.0.9 中引入的。

資源

編輯此頁面