在前端开发中，使用 ESLint 是非常常见的。它是一个帮助程序员写出更规范更易维护的 JavaScript 代码的工具。然而，当你使用它时，可能会遇到像 "no-underscore-dangle" 这样的报错，这意味着你的代码中使用了下划线（underscore）而 ESLint 认为这是一个不规范的做法。
什么是下划线（underscore）？
在 JavaScript 中，下划线（underscore）是一个普通的字符，它没有任何特殊含义。它只是一个用于变量名、函数名等命名方式中的字符。
然而，使用下划线来命名变量、函数等实体是一个很常见的做法。它通常用于表示私有变量或私有函数，表明它们是不应该被外部访问的。这是由于在 JavaScript 中，没有一种明确的机制可以确保变量或方法不被外部代码访问。因此，使用下划线作为表示 "私有" 和 "不应该被外部访问" 的一种约定。
ESLint 中的 no-underscore-dangle 规则
"no-underscore-dangle" 是 ESLint 中的一个规则，它被设计用于检测代码中不规范的下划线使用，以帮助程序员编写更好的代码。具体地说，它会检查代码是否包含以下情况：
- 在变量名或函数名的开头或结尾使用下划线。例如，"foo"、"foo"、"foo" 等。
- 在对象的 "key" 中使用下划线。例如，{ _foo: "bar" }。
- 在类成员变量中使用下划线。例如，class MyClass { _foo = "bar"; }。
如果代码中包含以上情况，ESLint 将会输出类似于以下的报错：
"no-underscore-dangle" 不允许下划线作为标识符的一部分
为什么要避免使用下划线？
虽然在 JavaScript 中使用下划线命名实体是一种很流行的编码规范，但它并不是一种官方的标准，也不是语言规范的一部分。使用下划线的做法有以下一些问题：
可读性
使用下划线的做法会影响代码的可读性，因为它需要程序员记住这是否是一个不能被外部访问的变量或函数。如果变量或函数的名称中包含了下划线，它的含义将不够明确，可能会导致程序员产生误解。
编辑器提示
潜在的问题是，一些编辑器并不会在编辑时提示下划线变量。如果你在使用一些静态代码检查工具，如 ESLint 或 TypeScript 等，它们会可能会给出错误警告，这可能不符合代码编写实践和编码标准。
因此，更好的做法是保持变量、函数名称清晰明了。
如何解决 no-underscore-dangle 报错？
如果你不想将下划线从代码中删除，则需要对 ESLint 的 no-underscore-dangle 规则进行配置。你可以通过在 .eslintrc 文件中添加如下规则来关闭它:
"no-underscore-dangle": 0
该规则的值设置为 0，表示禁用该规则。在此之后，ESLint 将不再警告或报错关于下划线的使用。
但是，考虑到代码的可读性和可维护性，建议你将下划线作为变量名、函数名等实体的一部分进行消除。当然,这并不适用于某些特殊情况下。
示例代码：
不规范的写法
-- -------------------- ---- -------
----- ---- - ------
-------- ------------------ -
------ -----
-
----- ---------- - -
----------------- ----------
--
----- ------- -
---------------- -
-------------------- ---------
-
-规范的写法
-- -------------------- ---- -------
----- --- - ------
-------- ----------------- -
------ -----
-
----- ---------- - -
---------------- ----------
--
----- ------- -
--------------- -
-------------------- ---------
-
-总结
"no-underscore-dangle" 是 ESLint 中的一条规则，用于检查代码中下划线的使用是否不规范。使用下划线命名变量和函数的做法在一定程度上影响了代码的可读性和可维护性，建议开发者避免使用它。如果需要使用下划线，则需要关闭相关规则或通过其他方式解决问题。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/64f1adfdf6b2d6eab3b82972