SONAR未记录的公共API因单元测试而倾斜

时间:2013-04-18 10:21:13

标签: unit-testing sonarqube static-code-analysis

SONAR指标包含用于评估文档质量的部分,其中包含项Public undocumented API。这在我们的项目中非常高,因为它报告了每个单元测试。但是,Junit必须公开单元测试方法。

是否有一种简单的方法从未记录的API指标中删除单元测试方法

我知道这些替代方案:

  • 我们可以为每个测试方法添加JavaDoc注释。这没用,因为它只会污染代码。
  • 测试在Eclipse测试片段项目中。我们可以从SONAR分析中完全排除测试类。但是,我们通常希望将相同的规则应用于测试代码和生产代码(例如,在检查违规时)。

我没有在SONAR配置中找到与该指标匹配的部分,但我可能错过了它。

1 个答案:

答案 0 :(得分:1)

此指标不包含单元测试类,您必须在配置中遗漏某些内容。

例如,请查看Sonar analysed by Sonar (on Nemo):您将看到没有为" public_undocumented_api"报告测试类。