構文

@generator

概要

@generator タグは、関数が ジェネレーター関数であることを示します。つまり、function* foo() {} 構文を使用して宣言されていることを意味します。このタグは、JSDoc 3.5.0 以降で使用できます。

通常、このタグを使用する必要はありません。JSDoc はジェネレーター関数を自動的に検出して、生成されたドキュメントでそれを識別するためです。ただし、コードに表示されないジェネレーター関数の仮想コメントを書く場合は、このタグを使用して関数がジェネレーター関数であることを JSDoc に指示できます。

例

次の例は、@generator タグを使用する仮想コメントを示しています。

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