@use JSDoc

同义词

语法

@yields [{type}] [description]

概述

@yields 标记记录生成器函数产生的值。此标记在 JSDoc 3.5.0 及更高版本中可用。

如果您记录的是常规函数，请使用 @returns 标记，而不是此标记。

示例

具有类型的 @yields 标记
/**
 * Generate the Fibonacci sequence of numbers.
 *
 * @yields {number}
 */
function* fibonacci() {}
具有类型和说明的 @yields 标记
/**
 * Generate the Fibonacci sequence of numbers.
 *
 * @yields {number} The next number in the Fibonacci sequence.
 */
function* fibonacci() {}