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

Question

我想在我的所有课程上应用注释，并且我正在尝试最好的方法来做到这一点。到目前为止，我坚持使用可以注释整个包的 package-info.java 文件，但不能注释子包中包含的类文件。除了在我的项目中添加 100 个仅包含单个注释的相同 package-info.java 文件之外，还有更有效的方法吗？

谢谢

Answer 1

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

最后，要抑制测试上以及存在包注释定义的包上的 checkstyle 规则，请使用以下抑制规则：

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