Question

public void destroy() {
}

我在我的过滤器类中写了上面的空方法，这是根据接口所必需的。但是当我的代码进入PMD检查它时会提到

Uncommented Empty Method查找方法不包含语句但没有注释的实例。通过显式注释空方法，可以更容易区分有意（注释）和无意的空方法。

我不明白。这究竟是什么意思？

Answer 1

当你有一个空体的方法时，你可能开始编写方法然后忘记插入正文。如果你打算让这个方法为空，你应该做一个注释（在注释中）来解释它是故意的。在Filter的情况下，由于您必须实现destroy()方法，因此您应该编写一条注释，其中包含“无需清理”的内容。

Answer 2

这意味着 - 在PMD术语中 - 您必须在中留下一个空方法，因此很明显该方法应该是空。

如果您愿意，也可以对方法的外部进行评论，但这不能满足PMD。

Answer 3

这个警告几乎解释了自己。

当你留下一个空方法时，你应该留下评论说明为什么它是空的，谁做了它以及何时/谁负责写它。这样用户就知道为什么会在这里，谁应该使用它，为什么它不起作用

Answer 4

在某些情况下，如果你必须为每个空方法体添加相同的注释，它可能只会给类添加额外的混乱（例如，如果你实现的接口有很多方法，但你只对使用一种方法）。

使用此注释来禁止警告：

@SuppressWarnings("PMD.UncommentedEmptyMethodBody")