标记JSDoc不推荐使用的类

时间:2018-11-06 18:28:09

标签: javascript jsdoc

我正在开发一个代码库,随着时间的推移,很多React组件都将被重写和替换。其中一些组件是“功能性的”,并且在它们中添加弃用标签会在我的IDE中触发警告和删除线样式。但是,对一个类进行相同的操作不会触发相同的视觉反馈。

在没有来自IDE的反馈的情况下,并且由于JSDoc docs的稀疏性,我不确定语法是否正确,或者@deprecated标签是否适用于类:

/**
 * @deprecated
 */
class OldAndBusted extends React.Component

相同的语法适用于类吗?您可以将它们标记为已弃用,方法与功能相同吗?

1 个答案:

答案 0 :(得分:2)

根据官方文档(http://usejsdoc.org/tags-deprecated.html

  

@deprecated标记将代码中的符号标记为已弃用。

没有说Scanner in = new Scanner(System.in); String prima = in.next(); String seconda = in.next(); String terza = in.next(); System.out.println(prima.toCharArray()[0]+seconda.toCharArray()[0]+terza.toCharArray()[0]); 标签仅用于功能。将类标记为@deprecated应该很好。

您的IDE是否理解它的事实,取决于您的IDE!

IDE的jsDoc解释不完整,很多事情还不了解。