@use JSDoc

同義詞

語法

@function [<FunctionName>]

概述

此標記將物件標記為函式,即使解析器可能不會將其視為函式。它將文件說明的 @kind 設為「函式」。

範例

使用 @function 標記函式。
/** @function */
var paginate = paginateFactory(pages);

沒有 @function 標記時,paginate 物件會被記錄為一般物件(@member),因為無法從檢查程式碼行中判斷執行 paginate 時會包含哪種類型的值。

使用 @function 搭配名稱。
/** @function myFunction */

// the above is the same as:
/** @function
 * @name myFunction */