@use JSDoc

語法

@name <namePath>

概述

@name 標籤強制 JSDoc 將 JSDoc 註解的其餘部分與給定的名稱關聯起來,並忽略所有周圍的程式碼。此標籤最適合用於程式碼中不易看到的符號的「虛擬註解」,例如在執行階段產生的方法。

當您使用 @name 標籤時,您必須提供額外的標籤,告訴 JSDoc 您正在記錄哪種類型的符號;符號是否為另一個符號的成員;等等。如果您未提供此資訊,符號將無法正確記錄。

警告:透過使用 @name 標籤,您告訴 JSDoc 忽略周圍的程式碼,並孤立地處理您的文件註解。在許多情況下,最好改用 @alias 標籤,它會變更文件中符號的名稱,但保留符號的其他資訊。

範例

以下範例顯示如何使用 @name 標籤來記錄 JSDoc 通常無法辨識的函式。

使用 @name 標籤
/**
 * @name highlightSearchTerm
 * @function
 * @global
 * @param {string} term - The search term to highlight.
 */
eval("window.highlightSearchTerm = function(term) {};")