構文

@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