Qu'est-ce que package-info.Java et comment puis-je l'ajouter à mon projet?

Question

Lorsque je lance Checkstyle sur mon projet Spring, cela dit:

- Missing package-info.Java file.

1. qu'est-ce que package-info.Java et en quoi est-il utile?
2. comment puis-je gérer ce message?

Answer 1

Est utilisé pour stocker la description javadoc. Vous pouvez le trouver sur 7.4.1. Packages nommés de La spécification du langage Java® :

Il est recommandé de package-info.Java, s'il est présent, remplacez package.html pour javadoc et d'autres systèmes de génération de documentation similaires. Si ce fichier est présent, l'outil de génération de documentation doit rechercher le commentaire de documentation du package précédant immédiatement la déclaration de package (éventuellement annotée) dans package-info.Java. De cette façon, package-info.Java devient le seul référentiel pour les annotations et la documentation au niveau du package. Si, à l'avenir, il devient souhaitable d'ajouter toute autre information au niveau du package, ce fichier devrait s'avérer pratique pour ces informations.

Un exemple:

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

Vérifiez également cette réponse

[~ # ~] mise à jour [~ # ~] d'ici

Aide à l'ajout de package-info.Java à vos packages

Alors que vous pouvez ajouter le fichier package-info.Java à vos packages à la main (tout comme vous pouvez créer Java classes à la main), les IDE vous offrent souvent la possibilité d'inclure un package-info. Fichier Java à chaque fois que vous créez un nouveau package. Eclipse, illustré ci-dessous, propose une case à cocher simple (et souvent négligée) dans l'assistant de création de packages New Java Java).