@非推奨
タグタイプ: ブロックタグ
TSDoc 標準化: コア
@deprecated
タグは、API アイテムがサポートされなくなり、将来のリリースで削除される可能性があることを示します。推奨される代替案を説明する文章が続く必要があります。(これは JSDoc では省略可能ですが、AEDoc では必須です。) @deprecated
タグは、任意のリリース タグ (@internal
、@alpha
、@beta
、または @public
) と組み合わせることができます。コンテナのメンバーに再帰的に適用され、たとえば、クラスが非推奨とされた場合、そのすべてのメンバーも非推奨になります。
使用例
/**
* The base class for all graphical components.
*
* @deprecated The BaseWidget class has been superceded by the BaseControl class.
* @public
*/
export class BaseWidget {
...
}