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 "*/".

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

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.

JOptionPane

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JOptionPane

Sirve para los cuadros de dialogos. Hace que sea fácil para que aparezca un cuadro de diálogo estándar que pide a los usuarios un valor o les informa de algo. Mientras que la clase JOptionPane puede parecer compleja debido a la gran cantidad de métodos, casi todos los usos de esta clase son las llamadas a los métodos estáticos showxxxdialog que se muestran a continuación 

Method Name                     Description  

showConfirmDialog          Asks a confirming question like yes/no/cancel.  

showInputDialog               Promt for some input.

showMessageDialog         Tell the user about something that has happened  

showOptionDialog            The unification of the above three.  

La apariencia básica de un cuadro de dialogo en java a pesar de los Look-and-Feels es como se ve en la siguiente figura.

Los parámetros de los métodos antes mencionados 

• parentComponent Define el componente que es el parent(padre) del cuadro de dialogo. Este parámetro puede ser null, en cuyo caso se centra en la pantalla y no depende de ningún frame.
• message A descriptive message to be placed in the dialog box. In the most common usage, message is just a String or String constant. However, the type of this parameter is actually Object. Its interpretation depends on its type:
• Object[] An array of objects is interpreted as a series of messages (one per object) arranged in a vertical stack. The interpretation is recursive -- each object in the array is interpreted according to its type.
• Component The Component is displayed in the dialog.
• Icon The Icon is wrapped in a JLabel and displayed in the dialog.
• others The object is converted to a String by calling its toString method. The result is wrapped in a JLabel and displayed.
• message Type Defines the style of the message. The Look and Feel manager may lay out the dialog differently depending on this value, and will often provide a default icon. The possible values are:
• ERROR_MESSAGE
• INFORMATION_MESSAGE
• WARNING_MESSAGE
• QUESTION_MESSAGE
• PLAIN_MESSAGE

• option Type Defines the set of option buttons that appear at the bottom of the dialog box.You aren't limited to this set of option buttons. You can provide any buttons you want using the options parameter:
• DEFAULT_OPTION
• YES_NO_OPTION
• YES_NO_CANCEL_OPTION
• OK_CANCEL_OPTION

• options A more detailed description of the set of option buttons that will appear at the bottom of the dialog box. The usual value for the options parameter is an array of Strings. But the parameter type is an array of Objects. A button is created for each object depending on its type:
• Component The component is added to the button row directly.
• Icon A JButton is created with this as its label.
• other The Object is converted to a string using its toString method and the result is used to label a JButton.
• icon A decorative icon to be placed in the dialog box. A default value for this is determined by the messageType parameter.
• title The title for the dialog box.
• initial Value The default selection (input value).

Ejemplos