語法

@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.
 */