@use JSDoc

構文

@name <名前パス>

概要

@nameタグはJSDocに残りのJSDocコメントを指定された名前と関連付け、周囲のすべてのコードを無視させます。このタグは、実行時に生成されるメソッドなど、コードではすぐに確認できないシンボルの「仮想コメント」で最適に使用されます。

@nameタグを使用する場合は、ドキュメント化するシンボルの種類、シンボルが別のシンボルのメンバーであるかなど、JSDocに指示する追加のタグを含める必要があります。この情報を入力しないと、シンボルは正しくドキュメント化されません。

注意: @nameタグを使用すると、周囲のコードは無視され、@aliasタグを使用することをお勧めします。これによりドキュメント内のシンボルの名前が変更されますが、シンボルに関するその他の情報は保持されます。

例

次の例は、JSDocが通常認識しない関数をドキュメント化する@nameタグの使用方法を示しています。

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