package-info.java包注释会影响所有类,包括子包中的类

时间:2014-08-19 19:31:50

标签: java annotations packages

我想在我的所有课程上应用注释,我正在尝试最好的方法。 到目前为止,我仍然使用package-info.java文件,该文件可以注释整个包,但不包含子包中包含的类文件。除了在我的项目中添加100个相同的package-info.java文件(仅包含一个注释)之外,还有更有效的方法吗?

感谢

1 个答案:

答案 0 :(得分:2)

看起来没有办法做到这一点。 我为那些package-info.java添加了静态分析checkstyle检查,以确保它们始终存在。 有关详细信息,请参阅:http://checkstyle.sourceforge.net/config_javadoc.html。 然后,如果你对项目运行checkstyle静态分析,它会抱怨任何缺少的package-info.java文件。

最后,要抑制测试的checkstyle规则,以及存在包注释定义的包,请使用此抑制规则:

<suppress checks="JavadocPackage" files="PackageNonnull.java|[/\\]src[/\\]test[/\\]java[/\\]"/>