对象的@property，tslint 给出错误 - no-redundant-jsdoc答案

【问题标题】：@property of an object, tslint gives error - no-redundant-jsdoc对象的@property，tslint 给出错误 - no-redundant-jsdoc
【发布时间】：2020-02-06 17:50:21
【问题描述】：

我正在为我的打字稿代码使用 tslint。我想记录一个接口的属性。 tsLint 报错JSDoc tag '@property' is redundant in TypeScript code. (no-redundant-jsdoc)tslint(1)

以下是我的评论

/**
 * @property value - number with a unit as string
 */

为下一行禁用 tslint 也不起作用。

【问题讨论】：

标签： javascript angular typescript jsdoc tslint

【解决方案1】：

如果这对你有用，你可以为整个文件禁用它吗？

【讨论】：

虽然在这种情况下并不理想，但我仍然想知道在整个文件中禁用 lint 是如何工作的。
@Kumar Sidharth：虽然很老，但应该在文件的第一行使用/* tslint:disable no-redundant-jsdoc*/ 来完成。通常，这会禁用任何后续行的规则，直到文件结束。您可以在tslint's official docs on rule flags 阅读更多相关信息。

【解决方案2】：

这是 tslint 中对no-redundant-jsdoc 问题的修复，它对我有用（基本上我禁用了 lint 抛出该错误/问题）：

在您的项目根目录中打开 tslint.json 文件。
将"no-redundant-jsdoc": true 行替换为"no-redundant-jsdoc": false

返回并检查有问题的错误/文件。现在应该解决了。

【讨论】：

小心：虽然这会禁用此特定情况的警告，但它也会停用整个项目的规则。通常，您不希望针对 lint 规则的特定误报执行此操作。