【问题标题】:Hiding Commented code for Docco from SonarQube review从 SonarQube 审查中隐藏 Docco 的注释代码
【发布时间】:2015-08-19 18:33:58
【问题描述】:

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

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

是否有任何已知的最佳实践让 SonarQube 忽略 cmets 中用于文档的代码(尤其是对于 Docco 更好),同时仍然捕获已被注释掉而不是被删除的旧代码?

【问题讨论】:

    标签: comments sonarqube docco


    【解决方案1】:

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

    【讨论】:

    • Simon,感谢您的回复,但我们仍在寻找被注释掉的代码,但不包括捕获作为文档一部分的注释代码。我希望有一些包装器或其他东西可以放在我们想要的注释代码周围,同时仍然捕获刚刚被注释掉而不是被删除的代码。
    【解决方案2】:

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

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

    例子

    #  print("sample")
    

    你可以这样写

    # ' print("sample")
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 2010-09-25
      • 2021-09-02
      • 2015-09-03
      • 2017-07-12
      • 2020-01-27
      • 2016-09-13
      • 2012-03-04
      相关资源
      最近更新 更多