Comentarios y documentación javadoc

NOTA. Este apartado no es esencial para el desarrollo del curso. Si no dispones de tiempo puedes saltártelo.

Los comentarios en Java se introducen de la misma forma que en C o en C++.

// Comentario de una línea

/* Comentario de

varias líneas */

La documentación del código resulta vital si queremos que este sea reutilizable. Java nos permite realizar esta importante tarea utilizando en mínimo esfuerzo. Para descubrir cómo se utiliza te proponemos el siguiente ejercicio.

Ejercicio paso a paso: Documentación del código utilizando javadoc.

1.     Desde Android Studio, accede a File >Settings.. >Editor > General y activa la opción Show quick doc on mouse move.

2.    En el proyecto Complejos visualizar el código de la clase Principal.

3.     Sitúa el ratón sobre la palabra  suma . Aparecerá una ventana como la siguiente:

 

 

Te preguntarás cómo es posible que Eclipse ya disponga de la documentación de una clase que acabamos de escribir.

4.     Para responder a esta pregunta visualiza la clase  Complejo  y comprueba que el comentario introducido antes de método  suma  es:

/** Suma al complejo de este objeto otro complejo.

* @param v el complejo que sumamos

*/

Todo comentario que introduzcamos de la forma /** … */ será utilizado por Java para documentar el elemento que es definido a continuación. Este elemento puede ser una clase, una variable o un método. A este sistema de documentación automática se le conoce como javadoc.

Lee las siguientes secciones del libro:

Si quieres ampliar sobre estos conceptos puedes leer del libro “Pensando en Java” el último apartado del capítulo 2: “Comentarios y documentación empotrada”

 Practica: Documentación de la clase coordenadas geográficas

Documenta todos los elementos de la clase GeoPunto.