---
url: /docs/guide/usage/linter/rules/eslint/symbol-description.md
---

### 它的作用

要求符号描述。

### 为什么这不好？

Symbol 函数可以带有可选的描述。

```js
var foo = Symbol("some description");

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

使用 `description` 可以更轻松地调试：当输出一个 symbol 时，会使用该描述：

```js
var foo = Symbol("some description");

console.log(foo);
// 输出 - Symbol(some description)
```

### 示例

以下是此规则的**错误**代码示例：

```javascript
var foo = Symbol();
```

以下是此规则的**正确**代码示例：

```javascript
var foo = Symbol("some description");
```

## 如何使用

## 版本

此规则在 v0.4.0 中添加。

## 参考资料