同義詞
yield
語法
@yields [{type}] [description]
概述
@yields
標籤記錄產生器函數產生的值。此標籤在 JSDoc 3.5.0 及後續版本中可用。
如果您要記錄常規函數,請使用 @returns
標籤,而不是此標籤。
範例
/**
* 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() {}