我们的组织正在使用SonarQube来管理代码质量,以及Docco用于处理代码注释中的文档生成。
我们在Docco的评论中包含诸如方法名称之类的内容之间发生冲突,而且“代码段”不应该被注释掉"' SonarQube中的规则。
是否有任何已知的最佳做法让SonarQube忽略用于文档的注释中的代码(特别是对于Docco更好),同时仍然捕获已被注释掉而不是被删除的旧代码?
答案 0 :(得分:0)
可以在与项目相关的质量配置文件中简单地禁用规则“不应注释掉代码段”。
答案 1 :(得分:0)
分享此内容,因为如果有类似问题,这可能会有所帮助。
一种方法是注释代码以及其他行或单引号,以忽略对我有用的那一行
示例
# print("sample")
您可以将其写为
# ' print("sample")