@alpha

タグタイプ: 修飾子

TSDoc の標準化: 任意

@alpha 修飾子は 4 つの リリース タグ のうちの 1 つです。これは、API アイテムが最終的には公開されることを意図しているが、現在開発の初期段階にあることを示します。サードパーティは「アルファ」API を使用しないでください。

使用例:

/**
 * This is some example documentation.
 * @alpha
 */
export function doSomething(): void {}

参照:

• ドキュメント コメント構文: リリース タグ
• .d.ts ロールアップ