When I run Checkstyle over my Spring project it says:
- Missing package-info.java file.
Is used to store javadoc description. You can find it at 7.4.1. Named Packages of the JLS:
It is recommended that
package-info.java, if it is present, take the place of
package.htmlfor javadoc and other similar documentation generation systems. If this file is present, the documentation generation tool should look for the package documentation comment immediately preceding the (possibly annotated) package declaration in
package-info.java. In this way,
package-info.javabecomes the sole repository for package-level annotations and documentation. If, in future, it becomes desirable to add any other package-level information, this file should prove a convenient home for this information.
/** * Info about this package doing something for package-info.java file. */ package your.project.doSomething;
UPDATE from here
While you can add the package-info.java file to your packages by hand (just as you can create Java classes by hand), IDE’s often offer you the option to include a package-info.java file each time you create a new package. Eclipse, shown below, offers a simple (and often overlooked) checkbox in the New Java Package creation wizard.