1

我们的组织正在使用 SonarQube 来管理代码质量，并使用 Docco 来处理从代码注释生成文档。

我们在 Docco 的注释中包含诸如方法名称之类的内容与 SonarQube 中的“代码部分不应“注释掉””规则之间遇到冲突。

是否有任何已知的最佳实践让 SonarQube 忽略用于文档的注释中的代码（特别是对于 Docco 更好），同时仍然捕获已被注释掉而不是被删除的旧代码？

4

2 回答 2

0

可以在与您的项目相关的质量配置文件中简单地禁用规则“不应注释掉代码部分”。

于 2015-06-05T06:12:14.313 回答
0

分享这个，因为如果有人遇到类似问题，它可能会有所帮助。

一种方法是将代码与附加行或单引号一起注释以忽略对我有用的行

例子

#  print("sample")

你可以这样写

# ' print("sample")
于 2020-12-01T10:05:58.437 回答