@public

タグの種類: 修飾子

TSDoc 標準化: 任意

@public 修飾子は、4 つのリリースタグの 1 つです。これは、API 項目が正式にリリースされ、パッケージのサポートされるコントラクトの一部になったことを示します。SemVer バージョン管理スキームが使用されている場合、メジャーバージョンの増分なしに API シグネチャを変更することはできません。

使用例

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

参照

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