Javadoc![]() Javadoc es una utilidad de Oracle para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java. La mayoría de los IDEs los generan automáticamente. Javadoc también proporciona una API para crear doclets y taglets, que le permite analizar la estructura de una aplicación Java. Así es como JDiff puede generar informes de lo que ha cambiado entre dos versiones de una API.[1] Etiquetas JavadocPara generar API con Javadoc han de usarse etiquetas (tags) de HTML o ciertas palabras reservadas precedidas por el carácter "@". A continuación se explican algunas de las palabras reservadas - puede verse una lista completa de las tags con su correspondiente uso en oracle.com. Nota 1: En uso explica la semántica del texto tras el tag.
EjemploUn ejemplo de un Javadoc de un método. /**
* Inserta un título en la clase descripción.
* Al ser el título obligatorio, si es nulo o vacío se lanzará
* una excepción.
*
* @param titulo El nuevo título de la descripción.
* @throws IllegalArgumentException Si titulo es null, está vacío o contiene sólo espacios.
*/
public void setTitulo (String titulo) throws IllegalArgumentException
{
if (titulo == null || titulo.isBlank())
{
throw new IllegalArgumentException("El título no puede ser nulo o vacío");
}
else
{
this.titulo = titulo;
}
}
Referencias
Enlaces externos
Information related to Javadoc |