@deprecated
标签类型: 块标签
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 {
...
}