語法
@kind <kindName>
其中 <kindName> 為下列其中之一
- 類別
- 常數
- 事件
- 外部
- 檔案
- 函式
- 成員
- 混合
- 模組
- 命名空間
- 類型定義
概述
@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（將種類設定為「模組」）和「@kind constant」（將種類設定為「常數」），最後一個標籤會決定種類。
/**
* This will show up as a constant
* @module myModule
* @kind constant
*/
/**
* This will show up as a module.
* @kind constant
* @module myModule
*/