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"*/
/*eslint-env es6*/

var foo = Symbol();

此规则的正确代码示例：

/*eslint symbol-description: "error"*/
/*eslint-env es6*/

var foo = Symbol("some description");

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

何时不使用

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