Che cosa è package-info.java e come posso aggiungerlo al mio progetto?

Question

Quando eseguo Checkstyle sopra il mio progetto di primavera si dice:

- Missing package-info.java file. 

1. qual è package-info.java e come è utile?
2. come posso gestire questo messaggio?

Answer 1

Viene utilizzato per memorizzare la descrizione di javadoc. Lo si può trovare in 7.4.1. Named Packages della JLS:

Si raccomanda che package-info.java, se presente, prendono il posto di package.html per altri sistemi di generazione di documentazione simili javadoc e. Se questo file è presente, lo strumento di generazione della documentazione deve cercare il commento della documentazione del pacchetto immediatamente prima della dichiarazione del pacchetto (eventualmente annotata) in package-info.java. In questo modo, package-info.java diventa l'unico repository per annotazioni e documentazione a livello di pacchetto. Se, in futuro, diventa desiderabile aggiungere altre informazioni a livello di pacchetto, questo file dovrebbe essere una comoda base per queste informazioni.

Un esempio:

/** 
* Info about this package doing something for package-info.java file. 
*/ 
package your.project.doSomething; 

Also check this answer

UPDATEfrom here

Aiuto aggiungendo package-info.java per i pacchetti

Mentre è possibile aggiungere manualmente il file package-info.java ai pacchetti (proprio come è possibile creare classi Java a mano), gli IDE offrono spesso la possibilità di includere un file package-info.java ogni volta che si crea un nuovo pacchetto. Eclipse, mostrato di seguito, offre una semplice (e spesso trascurata) casella di controllo nella procedura guidata di creazione del nuovo pacchetto Java.