Scribd
Cargar
7 vistas

Minitutorial Javadoc

Cargado por

xagofaj366
Derechos de autor
© © All Rights Reserved
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
7 vistas

Minitutorial Javadoc

Cargado por

xagofaj366
Derechos de autor
© © All Rights Reserved
Formatos disponibles
Descarga como PDF, TXT o lee en línea desde Scribd
Está en la página 1/ 3

Mini-tutorial de Javadoc

Dada la completa integración de Javadoc con Eclipse, los comentarios los haremos con
Javadoc.
Como supongo que ya sabes, dejando el cursor encima de una función (y pulsando F2 si no
se ve todo) aparece una descripción de la misma. Pues eso que aparece es el Javadoc. Al
dejar el cursor encima de cualquier ocurrencia de un método en el código, aparece la
descripción que hayas escrito. Te explico cómo funciona.

Comentarios de funciones
Una vez terminada la función, para comentarla pon el cursor encima del encabezamiento,
justo en la linea de encima, escribe /** y dale a intro:

/** <- pon el cursor aquí, escribe /** y dale a intro

public boolean nombreMetodo (int var1, boolean var2) {

return false;}

Entonces Eclipse te hace una plantilla, como la que ves a continuación:

/**

* aquí va la descripción del método

* @param var1 aquí va la descripción de la variable var1

* @param var2 aquí va la descripción de la variable var2

* @return aquí va la descripción de lo que devuelve el método

*/

public boolean nombreMetodo (int var1, boolean var2) {

return false;}

Arriba va la descripción de la función. Tiene que ser, hablando claro, para tontos.
No des nada por supuesto, y si pones de más, mejor, que es gratis.
Debajo van los parámetros, con esta estructura: @param nombre descripción. El
tipo no se pone.
Debajo va lo que se devuelve, con la estructura: @return descripción. Otra vez, el
tipo no se pone.
Quedaría algo así:
/**

* Este método te hace la cama, te lava una ropa y te pone un bol de


cereales.

* @param var1 es el número de copos en el bol de cereales

* @param var2 indica si queremos los cereales con miel

* @return <i>true</i> si ha completado todas las tareas, <i>false</i>


en caso contrario

*/

public boolean nombreMetodo (int var1, boolean var2) {return false;}

Importante

Es muy importante que el comentario empiece por "/**". Si empieza por "//" o
"/*", verás que sale verde en vez de azul, y Javadoc no lo reconocerá.

Opcional

• Se pueden añadir varios campos a los comentarios. En Eclipse, basta con


poner una @ y esperar a que salgan todos los campos disponibles. El orden
de los campos no importa. Algunos útiles son:
◦ @deprecated para especificar que un método será eliminado en el
futuro (y así aparece tachado al escribirlo y evitas que otros lo usen
en su código)
◦ @author define quién lo ha escrito
◦ @throws para definir qué tipo de excepción lanza, muy útil para
poder capturarla cuando se llama al método
◦ @see para hacer referencia a otros métodos (en el siguiente punto
te explico cómo referenciar funciones)
• Se pueden hacer referencias a otras funciones con #. Basta con poner # y
esperar a que Eclipse muestre una lista de funciones disponibles. Es
importante poner la '#' para que funcione el refactor y para que al generar
el Javadoc se generen links correctamente. Si alguien no sabe lo que es el
refactor, que seleccione cualquier variable del código, y en el menú pinche
en Refactor -> Rename. Eso sólo es el principio, pero es más fácil verlo que
explicarlo.
• Se pueden usar etiquetas HTML para organizar los comentarios. Se pueden
usar <i>,<u> y <b> para dar formato (con sus respectivas etiquetas de
cierre), <li> para hacer listas, <table><tr><td> para hacer tablas, etc.
Por ejemplo:

/**
* Este es mi comentario bonito con formato.
* <table border=1>
* <tr><td><b><p align=center>1 <td><b><p align=center>2
* <tr><td>Blablabla<td>Blablablabla

* </table>
*/

Quedaría algo así:

Este es mi comentario bonito con formato.


1 2
Blablabla Blablablabla

Comentarios de funciones
Exactamente igual. Al terminar la clase, pon el cursor justo encima y escribe /**
intro. La única diferencia es que automáticamente añade el autor de la clase.

/**

* Esta clase representa a los Frosties

* @author Dani

*/
publicclass Frosties extends Cereales {

Se debe rellenar con una descripción de la clase.

Comentarios de variables
Los comentarios dentro de un método, aunque empiecen por "/**", no son
reconocidos por Javadoc.

Funciones por implementar (TODO, "por hacer")


Los comentarios con // que empiecen con TODO el eclipse los reconoce y los
marca con una etiqueta azul.

También podría gustarte