当我在Java项目上运行CheckStyle时,它说的Missing package-info.java file.
是某些类,但不是全部。我真的无法弄清楚为什么此消息仅在某些时候出现。此外,我的项目在没有package-info.java的情况下运行得很好。
package-info.java是做什么的?我的Java项目真的需要它吗?
当我在Java项目上运行CheckStyle时,它说的Missing package-info.java file.
是某些类,但不是全部。我真的无法弄清楚为什么此消息仅在某些时候出现。此外,我的项目在没有package-info.java的情况下运行得很好。
package-info.java是做什么的?我的Java项目真的需要它吗?
Answers:
它用于为程序包生成javadocs。
/**
* 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
Example result
所指的是readme.md吗?
不仅某些findbugs注释,而且公共库中的许多Java注释都将java.lang.annotation.ElementType.PACKAGE
类型作为其自身java.lang.annotation.Target
注释的可能值之一,例如:
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)。
package-info.java文件允许添加javadoc来记录整个软件包。例如,请参见http://docs.oracle.com/javase/7/docs/api/java/applet/package-summary.html。
如果您不关心缺少软件包说明文件,请忽略警告或禁用JavadocPackage检查。
该package-info.java是可以添加到任何Java源代码包的Java文件。它用于按名称提供“包”级别的信息。它包含软件包中使用的文档和注释。
答案中已经提供了javadoc示例,以下部分说明了如何在注释的情况下工作。
例如,在下面的文件中,它用于用org.jadira.usertype.dateandtime.joda.PersistentDateTime“替换” joda.time.DateTime的出现
@TypeDefs({
@TypeDef(name = "PersistentDateTime", typeClass = PersistentDateTime.class, defaultForType=DateTime.class)})
package xyz.abc;
import org.hibernate.annotations.TypeDef;
import org.hibernate.annotations.TypeDefs;
import org.jadira.usertype.dateandtime.joda.PersistentDateTime;
import org.joda.time.DateTime;
有许多可用的注释,可用于在“包装”级别执行不同的操作。可以在https://docs.jboss.org/hibernate/orm/3.5/api/org/hibernate/annotations/package-summary.html找到