@generator

.. @generator::

语法

@generator

概述

``@genere``标签表示函数是一个`生成函数<https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function*>`__, 意思是它是使用语法``function * foo(){}``声明的. 此标记在JSDoc 3.5.0及更高版本中可用.

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

示例

以下示例显示了使用``@genere``标记的虚拟注释:

Virtual comment with @generator tag

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