Why is package-info.java useful?

java maven checkstyle
Socrates picture Socrates · Feb 28, 2014 · Viewed 61.1k times · Source

When I run CheckStyle over my Java project it says Missing package-info.java file. for some classes, but not all of them. I can't really figure out why this message appears only sometimes. Furthermore my project runs perfectly fine without the package-info.java.

What does the package-info.java do? Do I really need it for my Java projects?

Answer

m-szalik picture m-szalik · Feb 28, 2014

It is used to generate javadocs for a package.

/**
* Domain classes used to produce .....
* <p>
* These classes contain the ......
* </p>
*
* @since 1.0
* @author somebody
* @version 1.0
*/
package com.domain;

Will generate package info for com.domain package:

Example result: https://docs.oracle.com/javase/7/docs/api/java/awt/package-summary.html

Related questions

Preventing checkstyle from running in a specific maven submodule

I would like to define a checkstyle run in a pom file, and have it run on all the submodules except certain specified ones. In other words, I need some sort of <excludes> (which exists but applies to …

Read More
Maven check style as a part of the build

Is there a possibility to somehow force maven to fail the build if there are some checkstyle errors? Now I have to run site goal to generate javadocs and checkstyle reports. I want to make it on install goal and …

Read More
Could not find artifact com.sun:tools:jar:0

I'm trying to use checkstyle and findbugs by doing mvn checkstyle:checkstyle but I have this error This error [ERROR] Failed to execute goal on project my-project: Could not resolve dependencies for project default:my-project:jar:1.1: Could not find artifact …

Read More