语法

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