JSDoc @yields 标签
目录
同义词
JSDoc @yield 标签
Syntax
@yields [{type}] [description]
Overview
The @yields tag documents the value that is yielded by a generator function. This tag is available
in JSDoc 3.5.0 and later.
If you are documenting a regular function, use the @returns tag instead of this
tag.
Examples
/**
* Generate the Fibonacci sequence of numbers.
*
* @yields {number}
*/
function* fibonacci() {}
/**
* Generate the Fibonacci sequence of numbers.
*
* @yields {number} The next number in the Fibonacci sequence.
*/
function* fibonacci() {}