语法

@kind <kindName>

其中 <kindName> 为以下之一

• class
• constant
• event
• external
• file
• function
• member
• mixin
• module
• namespace
• typedef

概述

@kind 标记用于记录正在记录的符号的种类（例如，类或模块）。符号的种类不同于符号的类型（例如，字符串或布尔值）。

通常情况下，您不需要 @kind 标记，因为符号的种类由文档注释中的其他标记决定。例如，使用 @class 标记自动暗示“@kind class”，而使用 @namespace 标记暗示“@kind namespace”。

示例

// The following examples produce the same result:

/**
 * A constant.
 * @kind constant
 */
const asdf = 1;

/**
 * A constant.
 * @constant
 */
const asdf = 1;

对于具有冲突种类的标记（例如，同时使用 @module（将种类设置为“module”）和“@kind constant”（将种类设置为“constant”）），最后一个标记决定种类。

/**
 * This will show up as a constant
 * @module myModule
 * @kind constant
 */

/**
 * This will show up as a module.
 * @kind constant
 * @module myModule
 */

相关链接

• @type