java 包注释,package-info.java包注释影响到所有类，包括那些在子包

最新推荐文章于 2022-05-14 10:29:38 发布

转载最新推荐文章于 2022-05-14 10:29:38 发布 · 199 阅读

文章标签：

#java 包注释

博主探讨了如何避免为项目中的每个子包手动创建并维护众多重复的package-info.java文件，以应用单一注解。通过Checkstyle实现静态分析检查，并使用suppression规则处理测试和已注解包的情况。

部署运行你感兴趣的模型镜像

I want to apply an annotation on all of my classes and I am trying the best way to do so.

So far I am stuck with the package-info.java file that can annotate a whole package, but not the class files contained in the sub-packages. Is there a more efficient way other than adding 100 identical package-info.java files in my project that only contain a single annotation?

thanks

解决方案

It looks like there is no way to do this.

I have added a static analysis checkstyle check for those package-info.java to make sure they are always there.

See: http://checkstyle.sourceforge.net/config_javadoc.html for more details.

Then if you run checkstyle static analysis on the project, it will complain for any missing package-info.java file.

Finally, to suppress the checkstyle rule on the tests, and on the package where the package annotation definition exists use this suppression rule:

您可能感兴趣的与本文相关的镜像