/* --> noten que esto no es javadoc
 * NombreClase.java
 *
 * Created on 4 de agosto de 2004, 11:36 --> fecha de creación del archivo
 */

/**
 *
 * @author  Nombre Completo del autor de la clase
 *
 * AQUI VA UNA DESCRIPCIÓN COMPLETA DE LA CLASE, QUE ENTIDAD REPRESENTA, QUE HACE
 * QUE CONTIENE, ETC.
 *
 * 
 * CONTROL DE CAMBIOS:
 * EN ESTA SECCIÓN DEBEMOS ESPECIFICAR LOS CAMBIOS QUE SE LE HAGAN A LA CLASE
 * DESPUÉS DE QUE SE HA CREADO (HAY QUE TENER EN CUENTA QUE UNA VEZ QUE CREEMOS
 * LA CLASE DEBEMOS POR LO MENOS ESPECIFICAR TODOS LOS MÉTODOS QUE VA A TENER LA 
 * CLASE ASI NO ESTEN IMPLEMENTADOS AÚN), ESTOS CAMBIOS INCLUYEN ADICIONAR 
 * NUEVGS ATRIBUTOS O MÉTODOS A LA CLASE, ELIMINAR ATRIBUTOS O MÉTODOS DE LA 
 * CLASE O MODIFICAR LOS YA EXISTENTES. SE DEBE SEGUIR EL SIGUIENTE FORMATO:
 *
 * Fecha        Autor       tipo        cambio      descripción
 *
 * LA IDEA ES QUE SE VAYA ARMANDO UNA TABLA CON LOS CAMBIOS QUE SE LE HAN HECHO
 * A LA CALSE CRONOLÓGICAMENTE.
 * LA FECHA ES LA FECHA EN LA QUE SE HACE EL CAMBIO
 * EL AUTOR ES LA PERSONA QUE HACE EL CAMBIO (IDEALMENTE DEBERIA SER EL MISMO
 * AUTOR DE LA CLASE)
 * EL TIPO DE CAMBIO PUEDE SER INSERTAR, ELIMINAR O MODIFICAR
 * CAMBIO ES EL NOMBRE DEL MÉTODO O ATRIBUTO QUE FUE INSERTADO, ELIMINADO O
 * MODIFICADO
 * DESCRIPCIÓN ES UNA DESCRIPCIÓN DETALLADA DE LO QUE SE HIZO
 */
public class NombreClase
{
    
    /**
     * EXPLICAR CADA UNO DE LOS ATRIBUTOS DE LA CLASE, QUE REPRESENTA, PARA QUE
     * SE USA, ETC.
     * IDEALMENTE TODOS LOS ATRIBUTOS DE UNA CLASE DEBEN SER PRIVADOS Y SI ES
     * NECESARIO SE IMPLEMENTAN MÉTODOS GET Y SET.
     * TODOS LOS ATRIBUTOS SE DEBEN DECLARAR ANTES DE EMPEZAR A DECLARAR LOS MÉTODOS
     * Y EL PRIMER MÉTODO QUE SE DEBE DECLARAR ES EL CONSTRUCTOR DE LA CLASE.
     */
    private int nombreAtributo;
    
    
    
    /**
     * AQUI VA UNA DESCRIPCIÓN DETALLADA DE LO QUE HACE EL MÉTODO
     *
     * @ param nombreParametro AQUI SE EXPLICA QUE PARAMETROS RECIBE EL MÉTODO,
     * HAY QUE DETALLAR QUE CONDICIONES SE ESPERA QUE CUMPLA CADA PARAMETRO Y PARA
     * QUE SE VA A USAR DENTRO DEL MÉTODO
     *
     * @throws SI EL MÉTODO LANZA ALGUNA EXCEPCIÓN, EXPLICAR QUE TIPO DE EXCEPCIÓN
     * LANZA Y EN QUE CASOS OCURRE ESO, ADEMÁS SE DEBE ESPECIFICAR QUE PASA CON
     * LAS OPERACIONES QUE SE ESTABAN EJECUTANDO Y LOS DATOS QUE SE TENIAN
     *
     * @return EXPLICAR QUE DEVUELVE EL MÉTODO Y BAJO QUE CONDICIONES
     */
    public int nombreMetodo( int nombreParametro)
    {
        return 0;
    }
}
