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在创建符号时强制执行这一规则，则可以安全地关闭此规则。

进一步阅读

• 符号对象规范：符号描述版本此规则在ESLint 3.4.0.Resources中引入

• Rule source

• Documentation source