語法

@async

概述

@async 標籤表示函式是 非同步，表示使用語法 async function foo() {} 宣告。請勿將此標籤用於其他類型的非同步函式，例如提供回呼的函式。此標籤在 JSDoc 3.5.0 及後續版本中提供。

一般來說，您不需要使用此標籤，因為 JSDoc 會自動偵測非同步函式，並在產生的文件檔中辨識它們。不過，如果您撰寫虛擬註解給未出現在程式碼中的非同步函式，您可以使用此標籤告訴 JSDoc 函式是非同步的。

範例

下列範例顯示使用 @async 標籤的虛擬註解

/**
 * Download data from the specified URL.
 *
 * @async
 * @function downloadData
 * @param {string} url - The URL to download from.
 * @return {Promise<string>} The data from the URL.
 */