Javadoc
Javadoc (originalmente en formato JavaDoc ) [1] es un generador de documentación creado por Sun Microsystems para el lenguaje Java (ahora propiedad de Oracle Corporation ) para generar documentación API en formato HTML a partir del código fuente de Java . El formato HTML se utiliza para agregar la conveniencia de poder vincular documentos relacionados con hipervínculos . [2]
El formato de "comentarios de documentos" [3] utilizado por Javadoc es el estándar industrial de facto para documentar las clases de Java. Algunos IDE , [4] como IntelliJ IDEA , NetBeans y Eclipse , generan automáticamente Javadoc HTML. Muchos editores de archivos ayudan al usuario a producir el código fuente de Javadoc y utilizan la información de Javadoc como referencias internas para el programador.
Javadoc también proporciona una API para crear doclets y etiquetas, que permite a los usuarios analizar la estructura de una aplicación Java. Así es como JDiff puede generar informes de lo que cambió entre dos versiones de una API.
Javadoc no afecta el rendimiento en Java, ya que todos los comentarios se eliminan en el momento de la compilación. Escribir comentarios y Javadoc sirve para comprender mejor el código y, por lo tanto, mantenerlo mejor.
Javadoc fue uno de los primeros generadores de documentación en lenguaje Java . [5] Antes del uso de generadores de documentación, se acostumbraba utilizar redactores técnicos que normalmente escribían solo documentación independiente para el software, [6] pero era mucho más difícil mantener esta documentación sincronizada con el propio software.
Java ha utilizado Javadoc desde la primera versión y, por lo general, se actualiza con cada nueva versión del Java Development Kit .
