是否可以在打字稿中将某些内容标记为已弃用？

Posted 2023-02-23

【中文标题】是否可以在打字稿中将某些内容标记为已弃用？

【英文标题】：Is it possible to mark something as deprecated in typescript?

【发布时间】：2020-06-30 12:02:14

【问题描述】：

我正在使用已弃用的方法为 javascript API 编写打字稿定义。这是文档的摘录（他们说 API，但它只是关于这种单一方法）：

此 API 无效。它已被维护以保持兼容性 目的。

出于兼容性目的，我还想在定义文件中记录此方法。但如果可能的话，我想以某种方式传达它已被弃用。

虽然我当前的问题只是关于定义文件中的弃用，但我也想在其他代码中使用此功能。所以问题更笼统：如何在打字稿中将某些内容标记为已弃用？

【问题讨论】：

看看github.com/microsoft/TypeScript/issues/390

【参考方案1】：

您可以使用 JSDoc cmets 标记已弃用的代码：

/**
 * @deprecated The method should not be used
 */
export const oldFunc = () => 

此外，this eslint rule 可以查看已弃用的方法并警告它们的用法。

【讨论】：

仅供参考，VSCode 从 v1.49 开始支持 @deprecated JSDoc 标签 code.visualstudio.com/updates/…