TS Linting。禁用强制私有方法要求方法文档

时间:2018-10-03 13:05:26

标签: typescript tslint

我在线上进行了一些挖掘,当私有方法没有文档时,我似乎无法找到阻止TS Linting显示错误的方法。

我想强制执行所有面向公众的方法的文档,而不是针对私有方法的文档。

有没有办法做到这一点?

1 个答案:

答案 0 :(得分:0)

似乎来自completed-docs规则。

您应该能够:

"completed-docs": [true, { "methods": {
  "locations": "instance",
  "privacies": ["public"]
}}]

在您的tslint.json中,它将覆盖您可能具有的所有默认规则。当然,您可以使用更多属性更新它,因为必需文档有很多选项。

更糟糕的是,您可以使用// tslint:disable之类的东西,但我认为您不必这样做。