如何记录@SuppressWarnings("unused")？
How to document @SuppressWarnings("unused")?
我从一个整体 java 项目中提取了一个模块。该模块包含 public 个常量，这些常量仅在该模块外部使用，但在整个应用程序中使用。现在我需要通过 @SuppressWarnings("unused") 忽略未使用的警告，因为有很多常量，如果我不忽略它们，它们会隐藏其他警告。
我实际上不喜欢这种方法，但从语义上讲，这些常量属于模块，至少我想记录为什么我首先选择抑制警告。 javadoc page 没有提供任何有关如何执行此操作的提示。
感谢您的建议？
由于 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 {
我从一个整体 java 项目中提取了一个模块。该模块包含 public 个常量，这些常量仅在该模块外部使用，但在整个应用程序中使用。现在我需要通过 @SuppressWarnings("unused") 忽略未使用的警告，因为有很多常量，如果我不忽略它们，它们会隐藏其他警告。
我实际上不喜欢这种方法，但从语义上讲，这些常量属于模块，至少我想记录为什么我首先选择抑制警告。 javadoc page 没有提供任何有关如何执行此操作的提示。
感谢您的建议？
由于 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 {