---
url: /docs/guide/usage/linter/rules/jsdoc/require-yields-description.md
---

### 它的作用

要求 `@yields` 标签提供描述。

### 为什么这很糟糕？

`@yields` 标签应该说明生成器会产出什么。

### 示例

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

```js
/**
 * @yields {string}
 */
function* quux() {
  yield "value";
}
```

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

```js
/**
 * @yields {string} 下一个值。
 */
function* quux() {
  yield "value";
}
```

## 如何使用

## 版本

此规则自 v1.68.0 起加入。

## 参考资料