Documentación técnica en mi proyecto

Ya se vio la importancia de la documentación. Procederé a considerarla en mi proyecto para lo cual utilizaré el código generado a partir del diagrama de clases que hice.


Primero comentarizo mis clases.




Clase Interfaz

/**
* Clase que crea la interfaz del editor y 
  recibe las acciones de las clases con las 
  que se relaciona para sus menús.
*
* @author Jair Viezca Esparza.
*
* Fecha de creación: 17 de Septiembre del 2011.
*
* Última actualización: 26 de Septiembre del 2011.
*/

import java.util.*;


/**
 * Clase Interfaz
 */
public class Interfaz {

  //
  // Fields
  //

  
  /**
  * Constructor de la clase interfaz
  */
  public Interfaz () { };
  
  //
  // Methods
  //


  //
  // Accessor methods
  //

  //
  // Other methods
  //

}

Clase accionesArchivo

/**
* Clase que define algunas de las acciones básicas del menú archivo
*
* @author Jair Viezca Esparza.
*
* Fecha de creación: 17 de Septiembre del 2011.
*
* Última actualización: 26 de Septiembre del 2011.
*/

import java.util.*;


/**
 * Clase accionesArchivo
 */
public class accionesArchivo {

  //
  // Fields
  //

  
  /**
  // Constructor de la clase 
  */
  public accionesArchivo () { };
  
  //
  // Methods
  //


  //
  // Accessor methods
  //

  //
  // Other methods
  //

  /**
   * Método que realiza todo el proceso funcional de el menú archivo. El parámetro
     event se utiliza para manejar las acciones de los menuitems
   * @param event
   */
  public void actionPerformed( ActionEvent event )
  {
  }


}

Clase accionesEdicion

/**
* Clase que define algunas de las acciones básicas del menú edición
*
* @author Jair Viezca Esparza.
*
* Fecha de creación: 17 de Septiembre del 2011.
*
* Última actualización: 26 de Septiembre del 2011.
*/

import java.util.*;


/**
 * Clase accionesEdicion
 */
public class accionesEdicion {

  //
  // Fields
  //

  
  /**
  // Constructor de la clase
  */
  public accionesEdicion () { };
  
  //
  // Methods
  //


  //
  // Accessor methods
  //

  //
  // Other methods
  //

  /**
   * Método que realiza todo el proceso funcional de el menú edición. El parámetro
     event se utiliza para manejar las acciones de los menuitems
   * @param event
   */
  public void actionPerformed( ActionEvent event )
  {
  }


}

Clase accionesFormato

/**
* Clase que define algunas de las acciones básicas del menú formato
*
* @author Jair Viezca Esparza.
*
* Fecha de creación: 17 de Septiembre del 2011.
*
* Última actualización: 26 de Septiembre del 2011.
*/

import java.util.*;


/**
 * Clase accionesFormato
 */
public class accionesFormato {

  //
  // Fields
  //

  
  //
  // Constructor de la clase
  //
  public accionesFormato () { };
  
  //
  // Methods
  //


  //
  // Accessor methods
  //

  //
  // Other methods
  //

  /**
   * Método que realiza todo el proceso funcional de el menú formato. El parámetro
     event se utiliza para manejar las acciones de los menuitems
   * @param event
   */
  public void actionPerformed( ActionEvent event )
  {
  }


}

Después me ubico en la carpeta en donde tengo mis archivos de código.

Mi carpeta inicial

Posteriormente entro al cmd y me dirijo hacia esa carpeta. Una vez ahí escribo el siguiente comando:

javadoc *.java

lo cual tomará todos esos comentarios escritos entre /** y */ de los documentos con extensión java, y creará los archivos con formato HTML ya sea en la misma carpeta o en otra donde se requiera.

Ejecución del javadoc

Mi carpeta después de javadoc

De todos esos archivos HTML el más importante es el index, así que lo abrí con Mozilla Firefox  y listo.

Documentación de mi proyecto

Esto es muy bueno ya que le da más formalidad al trabajo.