使用 JSDoc 标记 class 弃用
Mark a class deprecated with JSDoc
我正在开发一个代码库,随着时间的推移,其中许多 React 组件正在被重写和替换。其中一些组件是 "functional",向它们添加弃用标签会在我的 IDE 中触发警告和删除线样式。但是对 class 执行相同的操作不会触发相同的视觉反馈。
没有 IDE 的反馈,并且由于 JSDoc docs 的稀疏性,我不确定我的语法是否正确,或者 @deprecated
标签是否适用至 classes:
/**
* @deprecated
*/
class OldAndBusted extends React.Component
相同的语法是否适用于 classes?你能以与函数相同的方式将它们标记为 deprecated 吗?
根据官方文档(http://jsdoc.app/tags-deprecated.html)
The @deprecated tag marks a symbol in your code as being deprecated.
并不是说@deprecated
标签只是为了函数。将 class 标记为 @deprecated
.
应该是完全没问题的
你的 IDE 是否理解,...取决于你的 IDE !
IDEs的jsDoc解读不完整,很多东西没看懂
我正在开发一个代码库,随着时间的推移,其中许多 React 组件正在被重写和替换。其中一些组件是 "functional",向它们添加弃用标签会在我的 IDE 中触发警告和删除线样式。但是对 class 执行相同的操作不会触发相同的视觉反馈。
没有 IDE 的反馈,并且由于 JSDoc docs 的稀疏性,我不确定我的语法是否正确,或者 @deprecated
标签是否适用至 classes:
/**
* @deprecated
*/
class OldAndBusted extends React.Component
相同的语法是否适用于 classes?你能以与函数相同的方式将它们标记为 deprecated 吗?
根据官方文档(http://jsdoc.app/tags-deprecated.html)
The @deprecated tag marks a symbol in your code as being deprecated.
并不是说@deprecated
标签只是为了函数。将 class 标记为 @deprecated
.
你的 IDE 是否理解,...取决于你的 IDE !
IDEs的jsDoc解读不完整,很多东西没看懂