IntelliJ禁止API方法的未使用警告

Question

我最近从Eclipse切换到IntelliJ IDEA,我真的很喜欢检查员,发现它们标记了潜在的错误,警告对我来说非常有用.我遇到了他无法解决的问题:

我有一些Java项目在其他项目中用作API,因此它包含未使用的方法,这些方法标记为: 未使用的警告

我怎样才能为API方法抑制这种情况？是否有替代方法@SuppressWarnings("unused"),因为这也抑制了方法中有关未使用警告的警告,并且没有向读者说明此方法是为API使用而设计的,而不是仅仅在当前项目中使用？

Answer 1

@ Sebastian建议让你的类实现一个接口可能是从一个好的设计角度解决这个问题的最佳方法.但是当这是不切实际的时候,还有另一种选择......

"未使用的声明"检查允许您配置要忽略的入口点.作为其中一部分,您可以配置注释".

只需将检查配置为使用您使用库或您创建的方法注释公共API方法的注释.例如,这里我使用了@PublicApi我创建的注释.请注意,该方法未突出显示为未使用.但foo字符串仍然突出显示为未使用:

作为打开"设置"对话框的替代方法,并限制对编程流程的影响,您还可以使用" 快速修复"意图将所需的注释添加到"未使用的声明"设置中.在使用所需注释进行注释后,将光标放在突出显示的未使用方法(或类)名称上,并通过Alt+ Enter或⌘↩(或通过单击灯泡图标)调用"意图操作和快速修复"弹出窗口)并选择"抑制由' {annotation} ' 注释的方法:

Answer 2

为您的班级编写一个接口。实现接口方法的方法未标记为未使用。而是将接口中未使用的方法标记为未使用，但是在这里您可以放心使用，@SuppressWarnings("unused")因为您没有方法主体。您甚至可以@SuppressWarnings("unused")在整个界面之上编写。