JavaDoc en Funciones

      JavaDoc en Funciones.

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 para documentar clases de Java. La mayoría de los IDEs utilizan javadoc para generar de forma automática documentación de clases. BlueJ también utiliza javadoc y permite la generación automática de documentación, y visionarla bien de forma completa para todas las clases de un proyecto, o bien de forma particular para una de las clases de un proyecto.

A continuación, se muestra lo qué se debe incluir al documentar una clase:

a) Nombre de la clase, descripción general, número de versión, nombre de autores.

b) Documentación de cada constructor o método especialmente los públicos incluyendo: nombre del constructor o método, tipo de retorno, nombres y tipos de parámetros si los hay, descripción general, descripción de parámetros, descripción del valor que devuelve.