如何显式注释空方法


public void destroy() {
}

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

"未注释的空方法"查找方法不包含语句但没有注释的实例。通过显式注释空方法,可以更轻松地区分有意(注释(和无意的空方法。

我不明白。这到底是什么意思?

当您有一个具有空主体的方法时,可能是您开始编写该方法,然后忘记插入主体。如果您打算将该方法为空,则应(在注释中(注释以解释它是故意为空的。如果是 Filter ,由于您必须实现 destroy() 方法,因此您应该写一条注释,说"没有什么可清理的"。

这意味着 - 在

PMD 术语 - 您必须在空方法中留下注释,因此很明显该方法是空的。

如果您愿意,您也可以在

方法的外部进行注释,但这不会满足 PMD。

警告几乎可以解释自己。

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

在某些情况下,如果您

必须向每个空方法主体添加相同的注释(例如,如果您正在实现具有许多方法的接口,但您只对使用一种方法感兴趣(,则它可能只会给类增加额外的混乱。

使用此批注禁止显示警告:

@SuppressWarnings("PMD.UncommentedEmptyMethodBody")

相关内容

  • 没有找到相关文章

最新更新