版本

symbol-description

要求符号描述

Symbol 函数可以有一个可选的描述

var foo = Symbol("some description");

var someString = "some description";
var bar = Symbol(someString);

使用 description 可以促进更轻松的调试:当记录符号时,将使用描述

var foo = Symbol("some description");

> console.log(foo);
// Symbol(some description)

它可以帮助在调试过程中观察到符号时识别符号。

规则详情

此规则在创建符号时需要描述。

示例

此规则的错误代码示例

在游乐场中打开
/*eslint symbol-description: "error"*/

var foo = Symbol();

此规则的正确代码示例

在游乐场中打开
/*eslint symbol-description: "error"*/

var foo = Symbol("some description");

var someString = "some description";
var bar = Symbol(someString);

何时不使用它

此规则不应在 ES3/5 环境中使用。此外,如果您不想在创建符号时强制执行 description 的存在,则可以安全地关闭此规则。

版本

此规则在 ESLint v3.4.0 中引入。

进一步阅读

资源

更改语言