我们的组织正在使用SonarQube来管理代码质量,同时使用Docco来处理由代码注释生成的文档。
我们遇到了在Docco的注释中包含方法名和SonarQube的"代码部分不应该被"注释掉"规则之间的冲突。
是否有任何已知的最佳实践,让SonarQube忽略注释中的代码,这些代码是用于文档(甚至更好,如果特别是Docco),同时仍然捕获旧的代码,已经注释掉,而不是被删除?
规则"代码的部分不应该被注释掉"可以简单地在与您的项目相关的质量配置文件中禁用。
分享这些,因为它可以帮助如果有人有类似的问题。
一种方法是注释代码和附加行或单引号来忽略对我有效的行
例子# print("sample")
可以写成
# ' print("sample")