Los comentarios de Javadoc son un tipo especial de comentario en Java diseñado para generar documentación técnica de forma automática en formato HTML.
A diferencia de los comentarios estándar, estos son interpretados por la herramienta javadoc para extraer información sobre el código (como el autor, la versión o la descripción de los métodos) y crear manuales de referencia.
Características principales
- Sintaxis: Comienzan con
/**y terminan con*/. - Etiquetas especiales: Utilizan etiquetas precedidas por el símbolo
@para definir metadatos específicos:@author: Para indicar el autor del código.@version: Para especificar la versión actual del componente.@param: Para describir los parámetros que recibe un método.@return: Para explicar qué valor devuelve una función.@see: Para añadir una referencia o enlace a otra parte de la documentación.
Ejemplo de uso
Estos comentarios se colocan habitualmente justo antes de la declaración de clases, campos o métodos para que la herramienta pueda asociar la descripción con el elemento de código correspondiente.