为什么package-info.java有用？
为什么package-info.java有用？
提问于 2014-02-28 20:38:48
当我在我的Java项目上运行CheckStyle时，它为某些类显示Missing package-info.java file.，但不是所有类。我真的不明白为什么这条消息只是偶尔出现。此外，我的项目在没有包-info.java的情况下也运行得很好。
包-info.java做什么？我的Java项目真的需要它吗？
回答 3
Stack Overflow用户
回答已采纳
发布于 2014-02-28 20:46:03
它用于为包生成javadoc。
/**
* Domain classes used to produce .....
* <p>
* These classes contain the ......
* </p>
*
* @since 1.0
* @author somebody
* @version 1.0
*/
package com.domain;将为com.domain包生成包信息：
示例结果：https://docs.oracle.com/javase/7/docs/api/java/awt/package-summary.html
Stack Overflow用户
发布于 2017-01-04 23:42:18
不仅一些java.lang.annotation.Target批注，而且公共库中的许多java批注都将java.lang.annotation.ElementType.PACKAGE类型作为其自己的findbugs批注的可能值之一，例如：
com.google.gwt.core.client.js.JsNamespace
com.querydsl.core.annotations.Config
com.sun.xml.bind.XmlAccessorFactory
groovy.transform.BaseScript
java.lang.Deprecated
javax.annotation.Generated
javax.xml.bind.annotation.XmlAccessorOrder
org.hibernate.annotations.TypeDef
net.sf.ehcache.pool.sizeof.annotations.IgnoreSizeOf
org.apache.hive.common.HiveVersionAnnotation
org.apache.wicket.authroles.authorization.strategies.role.annotations.AuthorizeAction
org.codehaus.commons.nullanalysis.NotNullByDefault
org.eclipse.persistence.oxm.annotations.XmlNameTransformer
org.glassfish.jersey.Beta
org.jgroups.annotations.Experimental还有更多。
这个package-info.java文件就是您可以放置此类注释(以及javadoc)的文件。
Stack Overflow用户
发布于 2014-02-28 20:44:04
package-info.java文件允许添加javadoc来记录整个包。请参见http://docs.oracle.com/javase/7/docs/api/java/applet/package-summary.html示例。
如果您不关心缺少包文档，那么忽略警告或禁用JavadocPackage check。
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/22095487
复制相关文章
相似问题
腾讯云开发者
