语法

@generator

概述

@generator 标签表示一个函数是 生成器函数，这意味着它使用语法 function* foo() {} 声明。此标签在 JSDoc 3.5.0 及更高版本中可用。

通常，您不需要使用此标签，因为 JSDoc 会自动检测生成器函数并在生成的文档中标识它们。但是，如果您正在为未出现在代码中的生成器函数编写虚拟注释，则可以使用此标签告诉 JSDoc 该函数是一个生成器函数。

示例

以下示例显示了使用 @generator 标签的虚拟注释

/**
 * Generate numbers in the Fibonacci sequence.
 *
 * @generator
 * @function fibonacci
 * @yields {number} The next number in the Fibonacci sequence.
 */