¿Qué es package-info.java y cómo puedo agregarlo a mi proyecto?

spring hibernate

Question

Cuando ejecuto Checkstyle sobre mi proyecto Spring dice:

- Missing package-info.java file.

1. ¿Qué es package-info.java y para qué sirve?
2. ¿Cómo puedo manejar este mensaje?

Answer 1

Se utiliza para almacenar la descripción de javadoc. Lo puedes encontrar en 7.4.1. Paquetes con nombre de la JLS:

Se recomienda que package-info.java , si está presente, tome el lugar de package.html para javadoc y otros sistemas similares de generación de documentación. Si este archivo está presente, la herramienta de generación de documentación debe buscar el comentario de la documentación del paquete inmediatamente antes de la declaración del paquete (posiblemente anotada) en package-info.java . De esta manera, package-info.java convierte en el único repositorio de anotaciones y documentación a nivel de paquete. Si, en el futuro, es conveniente agregar cualquier otra información a nivel de paquete, este archivo debería ser un hogar conveniente para esta información.

Un ejemplo:

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

También revisa esta respuesta

ACTUALIZACIÓN desde aquí

Ayuda a agregar package-info.java a tus paquetes

Si bien puede agregar el archivo package-info.java a sus paquetes a mano (al igual que puede crear clases de Java a mano), los IDE a menudo le ofrecen la opción de incluir un archivo package-info.java cada vez que cree un paquete nuevo. . Eclipse, que se muestra a continuación, ofrece una casilla de verificación simple (y que a menudo se pasa por alto) en el asistente de creación del Nuevo Paquete Java.