@use JSDoc

同義語

構文

@yields [{type}] [decription]

概要

@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() {}