java - 如何忽略CheckStyle警告缺少测试方法的@throws？

CheckStyle警告有关在测试方法的JavaDoc中缺少@throws的问题使我感到困扰。

我正在使用编写这样的测试方法:

/**
 * Check that something works. <== CheckStyle wants @throws here
 */
@Test
public void testSomething() throws Exception {
  ...
}

有没有一种可配置的方式来告诉CheckStyle忽略这一点？

“throws”子句之所以存在，尤其是因为它是一种测试方法。通常会忽略异常处理。

最佳答案

是的。您可以为特定文件的检查样式错误指定抑制过滤器。参见Checkstyle 5.5, section SuppressionFilter。从那里，

筛选器SuppressionFilter根据文件中的禁止XML文档拒绝检查事件的检查错误。如果没有配置的禁止文件，则过滤器将接受所有审核事件。

<module name="SuppressionFilter">
    <property name="file" value="docs/suppressions.xml"/>
</module>

因此，在您的情况下，您可以执行以下操作:

<suppressions>
   <suppress checks="JavadocStyleCheck" files="*Test.java"/>
</suppressions>

我不确定JavadocStyleCheck是否真的是您要删除的支票，但请查看文档以了解更多信息。

关于java - 如何忽略CheckStyle警告缺少测试方法的@throws？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/9016848/