【发布时间】:2015-08-19 18:33:58
【问题描述】:
我们的组织正在使用 SonarQube 来管理代码质量,并使用 Docco 来处理从代码 cmets 生成文档。
我们在 Docco 的 cmets 中包含方法名称之类的内容与 SonarQube 中的“不应“注释掉代码部分”规则之间遇到冲突。
是否有任何已知的最佳实践让 SonarQube 忽略 cmets 中用于文档的代码(尤其是对于 Docco 更好),同时仍然捕获已被注释掉而不是被删除的旧代码?
【问题讨论】:
我们的组织正在使用 SonarQube 来管理代码质量,并使用 Docco 来处理从代码 cmets 生成文档。
我们在 Docco 的 cmets 中包含方法名称之类的内容与 SonarQube 中的“不应“注释掉代码部分”规则之间遇到冲突。
是否有任何已知的最佳实践让 SonarQube 忽略 cmets 中用于文档的代码(尤其是对于 Docco 更好),同时仍然捕获已被注释掉而不是被删除的旧代码?
【问题讨论】:
可以在与您的项目相关的质量配置文件中简单地禁用“不应注释掉代码部分”的规则。
【讨论】:
分享这个,因为如果有人遇到类似问题,它会有所帮助。
一种方法是将代码与其他行或单引号一起注释以忽略对我有用的行
例子
# print("sample")
你可以这样写
# ' print("sample")
【讨论】: