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 "*/".
| Tag | Descripción | Uso | Versión |
|---|---|---|---|
| @author | Nombre del desarrollador. | nombre_autor | 1.0 |
| @deprecated | Indica que el método o clase es antigua y que no se recomienda su uso porque posiblemente desaparecerá en versiones posteriores. | descripción | 1.0 |
| @param | Definición de un parámetro de un método, es requerido para todos los parámetros del método. | nombre_parametro descripción | 1.0 |
| @return | Informa de lo que devuelve el método, no se puede usar en constructores o métodos "void". | descripción | 1.0 |
| @see | Asocia con otro método o clase. | referencia (#método(); clase#método(); paquete.clase; paquete.clase#método()). | 1.0 |
| @throws | Excepción lanzada por el método | nombre_clase descripción | 1.2 |
| @version | Versión del método o clase. | versión | 1.0 |
//: 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 comandosjavadoc HolaFecha.java
En la carpeta se crean varios archivos html, y el index.html se ve asi.


No hay comentarios:
Publicar un comentario