JAVADOC

Herramienta de java para generar documentación básica para el programador a partir del código fuente.

Javadoc es un programa, que toma lo comentarios que se colocan en el código con marcas especiales y
construye un archivo HTML con clases, métodos y la documentación que corresponde.

Utiliad incluida en el JDK, que genera documentación automática en formato HTML, a partir de
código fuente Java.

Ejemplo:

USO DE JAVADOC

La documentacion que se vaya a usar debe escribirse en comentarios que comiencen con /** y
terminen */. Tambien en esos comentarios puede escribirse codigo HTLM y operadores precedidos por
@.

Ejemplo:
Cuando se presiona la tecla F2 o poner el cursor sobre un metodo , se puede observar.

Ejemplo:

INDICADORES EN JAVADOC

Es pensado con el fin de que otro programador los lea y utilice la clase correpondiente, se tiene un
formato comun para que estos comentarios fueran claros al momento de interpretarlos. Se debe incluir
indicadores especiales como @ y se ponen al principio de una linea ver @ver, no son obligatorios, en
un metodo sin parametros no se incluyen.

TIPOS DE INDICADORES JAVADOC

   @author nombreDelAutor descripción. 
Indica quién escribió el código al que se refiere el comentario. Si son varias personas se
escriben los nombres separados por comas o se repite el indicador, según se prefiera. Es normal
incluir este indicador en el comentario de la clase y no repetirlo para cada método, a no ser que
algún método haya sido escrito por otra persona. 

 @version númeroVersión descripción.
Si se quiere indicar la versión. Normalmente se usa para clases, pero en ocasiones también para
métodos. 

 @param nombreParámetro descripción.
Para describir un parámetro de un método.

 @return descripción.
Describe el valor de salida de un método. 

 @see nombre descripción. Cuando el trozo de código comentado se encuentra relacionada con

otra clase o método, cuyo nombre se indica en nombre.

 @throws nombreClaseExcepción descripción. Cuando un método puede lanzar una excepción

("romperse" si se da alguna circunstancia) se indica así.

 @deprecated descripción. Indica que el método (es más raro encontrarlos para una clase) ya no
se usa y se ha sustituido por otro.

  @exception descripción. Es la excepción que se puede llegar a generar. Es un sinónimo para

@exception.

  @since descripción.  Es la versión desde que se incluye.

DONDE UTILIZAR JAVADOC

Clases.

 Métodos.
 Constructores.
 Constantes.
 Propiedades (Aunque no es muy común el uso en ellas).
 Paquetes.
 Etc.

/**
3 * Clase Empleado
 4 *
5 * Contiene informacion de cada empleado
6 *
7 * @author Fernando
8 * @version 1.0
9 */
10public class Empleado {
11 
12    //Atributos
13 
14    /**
15     * Nombre del empleado
16     */
17    private String nombre;
18    /**
19     * Apellido del empleado
20     */
21    private String apellido;
22    /**
23     * Edad del empleado
24     */
25    private int edad;
26    /**
27     * Salario del empleado
28     */
29    private double salario;
30 
31    //Metodos publicos
32 
33    /**
34     * Suma un plus al salario del empleado si el empleado tiene mas de 40 años
35     * @param sueldoPlus
36     * @return <ul>
37     *          <li>true: se suma el plus al sueldo</li>
38     *          <li>false: no se suma el plus al sueldo</li>
39     *          </ul>
40     */
41    public boolean plus (double sueldoPlus){
42        boolean aumento=false;
43        if (edad>40 && compruebaNombre()){
44            salario+=sueldoPlus;
45            aumento=true;
46        }
47        return aumento;
48    }
49 
50    //Metodos privados
51    /**
52     * Comprueba que el nombre no este vacio
53     * @return <ul>
54     *  <li>true: el nombre es una cadena vacia</li>
55     *  <li>false: el nombre no es una cadena vacia</li>
56     *  </ul>
57     */
58    private boolean compruebaNombre(){
59        if(nombre.equals("")){
60            return false;
61        }
62        return true;
63    }
64 
65    //Constructores
66    /**
67     * Constructor por defecto
68     */
69    public Empleado(){
70        this ("", "", 0, 0);
71    }
72 
73    /**
74     * Constructor con 4 parametros
75     * @param nombre nombre del empleado
76     * @param apellido nombre del empleado
77     * @param edad edad del empleado
78     * @param salario salario del empleado
79     */
80    public Empleado(String nombre, String apellido, int edad, double salario){
81        this.nombre=nombre;
82        this.apellido=apellido;
83        this.edad=edad;
84        this.salario=salario;
85    }