【问题标题】:How to suppress missing javadoc warning in checkstyle on test method如何在测试方法的检查样式中抑制缺少的 javadoc 警告
【发布时间】:2017-04-18 06:01:11
【问题描述】:

在 Eclipse 中,我试图删除单元测试方法中缺少 javadoc 的 checkstyle 警告。在 checkstyle 模块Method Javadoc 的配置中,我尝试了allowedAnnotaions = @Test 和ignoreMethodNamesRegex,其值为“test” (我所有的测试方法都以test 开头)但是这些方法都不适合我。 知道如何解决吗?谢谢

【问题讨论】:

  • 欢迎来到 Stack Overflow!请查看我们的SO Question Checklist,以帮助您提出一个好问题,从而得到一个好的答案。
  • 您的工作空间是如何组织的? junit 测试是否放置在自己的文件夹中?在我的工作区中,我在“prod/src”中有生产类,在“junit/src”中有单元测试,我没有遇到这个问题,不需要明确定义 checkstyle 的范围。
  • 我的 junit 测试在 src/test/java 中,结构遵循 maven 约定。

标签: java eclipse-plugin javadoc checkstyle


【解决方案1】:

我通过右键单击测试文件夹并选择 checkstyle -> 清除 Checkstyle 违规找到了解决方案。

【讨论】:

  • 实际上,checkstyle 会忽略所有带有@Test 注释的方法。对我来说,它要求 @Before 方法的 Javadoc
  • @hydradon 我也有同样的问题。你解决了吗?
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2021-06-08
  • 1970-01-01
  • 1970-01-01
  • 2013-08-02
  • 1970-01-01
  • 2016-04-19
  • 2018-02-04
相关资源
最近更新 更多