構文

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