Buscar este blog

jueves, 29 de abril de 2010

Documentación del código con javadoc

Javadoc es una utilidad de Sun Microsystems para la generación de documentación de APIs en formato HTML a partir de código fuente Java. Javadoc es el estándar de la industria para documentar clases de Java

Etiquetas Javadoc
Para generar APIs con Javadoc han de usarse etiquetas (tag's) de HTML o ciertas palabras reservadas precedidas por el caracter "@".
Estas etiquetas se escriben al principio de cada clase, miembro o método, dependiendo de qué objeto se desee describir, mediante un comentario iniciado con "/**" y acabado con "*/".
TagDescripciónUsoVersión
@authorNombre del desarrollador.nombre_autor1.0
@deprecatedIndica que el método o clase es antigua y que no se recomienda su uso porque posiblemente desaparecerá en versiones posteriores.descripción1.0
@paramDefinición de un parámetro de un método, es requerido para todos los parámetros del método.nombre_parametro descripción1.0
@returnInforma de lo que devuelve el método, no se puede usar en constructores o métodos "void".descripción1.0
@seeAsocia con otro método o clase.referencia (#método(); clase#método(); paquete.clase; paquete.clase#método()).1.0
@throwsExcepción lanzada por el métodonombre_clase descripción1.2
@versionVersión del método o clase.versión1.0
Ejemplo
//: HolaFecha.java

import java.util.*;
import javax.swing.*;

/** Programa de ejemplo que muestra 
 * una cadena de caracteres y la fecha.
 * en un mensaje JOptionPane
 * @author RaMoNs
 * @author ramons03.blogspot.com
 * @version 1.0 
*/
public class HolaFecha extends JFrame{
  /** Único punto de entrada a clase y la aplicación
   * @param args argumentos de cadena
   * @return No hay valor de retorno
   * @exception No hay excepciones producidas
  */
  public static void main(String[] args) {
    JOptionPane.showMessageDialog(null,"La fecha del sistema es "+new Date());
  }
}

Ejecuta javadoc desde la lineas de comandos
javadoc HolaFecha.java

En la carpeta se crean varios archivos html, y el index.html se ve asi.



No hay comentarios:

Publicar un comentario