2.2 DOCUMENTACION

Una tarea importante en la generación de código es su documentación. El código no debe únicamente
ejecutarse sin errores si no que además debe estar bien documentado. Java facilita esta tarea utilizando
ciertas etiquetas en los comentarios de documentación.
Las siguientes son las etiquetas que se pueden utilizar en los comentarios de documentación:
•   @author [Nombre y Apellidos del autor]
•   @version [Información de la versión]
•  @param [nombreDelParametro] [Descripción]
•   @return [Descripción del parámetro devuelto]
•   @exception [Excepción lanzada]
•   @see [Referencia cruzada]
•   @deprecated [Comentario de porque es obsoleto]


Además, en los comentarios se puede insertar código html para resaltar la documentación.


Los comentarios de autor y versión se aplican sólo a las clases. Los comentarios de parámetros, retorno y
excepciones se aplican sólo a los métodos. Los comentarios de referencias cruzadas y obsolescencias se
pueden aplicar a clases, métodos y atributos. En Ejemplo 2-1 se muestra una clase con los comentarios
de documentación.