语法
@name <namePath>
概述
@name 标签强制 JSDoc 将 JSDoc 注释的其余部分与给定的名称相关联,忽略所有周围的代码。此标签最适合用于代码中不易看到的符号的“虚拟注释”,例如在运行时生成的函数。
使用 @name 标签时,必须提供其他标签,以告诉 JSDoc 你正在记录哪种符号;符号是否是其他符号的成员;等等。如果不提供此信息,则符号将无法正确记录。
警告:通过使用 @name 标签,你告诉 JSDoc 忽略周围的代码,并孤立地处理你的文档注释。在许多情况下,最好改用 @alias 标签,它会更改文档中的符号名称,但保留有关符号的其他信息。
示例
以下示例演示如何使用 @name 标签来记录 JSDoc 通常无法识别的函数。