tgr*_*tgr 6 java documentation javadoc
我从一个整体的 Java 项目中提取了一个模块。该模块包含公共常量,它们仅在该模块之外使用,但在整个应用程序中使用。现在我需要通过 忽略未使用的警告@SuppressWarnings("unused")
,因为有很多常量,如果我不忽略这些,它们会隐藏其他警告。
我实际上不喜欢这种方法,但从语义上讲,这些常量属于模块,至少我想记录为什么我首先选择取消警告。该javadoc的页面没有提供关于如何做到这一点的任何提示。
我很感激任何建议?
正如 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 {
Run Code Online (Sandbox Code Playgroud)
归档时间: |
|
查看次数: |
749 次 |
最近记录: |