如何记录@SuppressWarnings("未使用")?

时间:2018-01-23 11:58:37

标签: java documentation javadoc

我从一个单一的java项目中提取了一个模块。该模块包含公共常量,它们仅在该模块之外使用,但在整个应用程序中使用。现在我需要通过@SuppressWarnings("unused")忽略未使用的警告,因为有很多常量,如果我不忽略它们,它们会隐藏其他警告。

我实际上不喜欢这种方法,但在语义上这些常量属于模块,至少我想记录为什么我选择首先抑制警告。 javadoc page没有提供有关如何执行此操作的任何提示。

我很感谢你的建议吗?

1 个答案:

答案 0 :(得分:0)

由于J.Bloch在Effective Java中消磨(可能是第27项,消除未经检查的警告),我只是在这行注释的行上添加简单的非javadoc注释,这解释了为什么可以在那里抑制警告。

在我看来,对于API的用户来说,有什么警告被抑制是很有趣的,所以我不担心javadoc和开发人员实际阅读代码时评论就足够了。

所以在你的情况下,我可能会像:

//Many of the constants are unused, but removing them would require figuring out their values
//and names some day
@SuppressWarnings("unused")  
public class Foo {