//1. Bibliotecas 
/*========================================================================== 
  Encabezado de los Módulos (Bibliotecas) 
 =========================================================================== 
 */ 
import java.lang.*;            /* Breve descripción */ 



//--------------------------------------------------------------------------------

//2. Documentación de la Clase 

/*========================================================================== 
  Encabezado de la Clase 
 =========================================================================== 
 * CLASE: 
 * OBJETIVO: 
 * ASIGNATURA: 
 * @version número (VERSIÓN) y Fecha (mm/dd/aaaa) 
 * @author (AUTOR[ES]) 
 */ 

/** 
 * CLASE: NombreClase.java 
 * OBJETIVO: Mostrar un ejemplo de la plantilla de Documentación para Java en Javadoc 
 * ASIGNATURA o PROYECTO: 
 * =========== Documentación Opcional ============== 
 * COMANDO(S):javadoc -version -author -link http://java.sun.com/products/jdk/1.3/docs/api Plantilla.java 
 * REFERENCIA(S): Si existe alguna nota o cita bibliográfica o de otro tipo (internet por ejemplo) 
 *     Javadoc Example: http://java.sun.com/j2se/javadoc/writingdoccomments/index.html 
 *     Javadoc HomePage: http://java.sun.com/products/jdk/1.2/docs/tooldocs/win32/javadoc.html 
 * ================================================= 
 * @version 1.0 dd/mm/aaaa 
 * @author Pepito PEREZ 
 */ 

public class Plantilla { 



//--------------------------------------------------------------------------------

//4. Documentación de los Atributos 
   /*========================================================================== 
    * Atributos Principales 
    =========================================================================== 
    */ 

    /** Breve descripción */ 
    private String nombre; 



//--------------------------------------------------------------------------------

//5. Documentación de los Constructores 
   /*========================================================================== 
    * Método(s) Constructor(es) 
    =========================================================================== 
    * (Objetivo): Indicado el objetivo del método en una Frase. Las especificaciones se realizan después del punto. 
    */ 

    /** 
     * Inicializa una instancia "vacia" de un nuevo objeto Plantilla. Inicializa el atributo nombre con un caracter vacio 
     */ 

    public Plantilla () { 
     nombre = ""; 
    } //Fin Método Constructor 



//--------------------------------------------------------------------------------

//6. Documentación del Programa Principal (main) 
    /*========================================================================== 
     * Programa Principal 
     =========================================================================== 
    * (Objetivo): Indicado el objetivo del método en una Frase. Las especificaciones se realizan después del punto. 
    * Así como la especificación del programa principal en las siguientes líneas 
    */ 
  

    /** 
     * Imprime en la salida estandar "Plantilla de Documentación en Java" 
     */ 

    public static void main (String[] args) { 
     System.out.println("Plantilla de Documentacion de Java"); 
    } // Fin main 



//--------------------------------------------------------------------------------

//7. Documentación de los Métodos Analizadores y Modificadores 

 /**========================================================================== 
    Encabezado del Método Analizador 
    ========================================================================== 
    * (Objetivo)   : Objetivo del Método. 
    * Precondicion : Condición requerida para la ejecución correcta del método. 
    * @return Especificación del valor retornado, características y aspectos varios. 
    */ 



//--------------------------------------------------------------------------------

  // Ejemplo Analizador: 
 /** 
  * Retorna el valor del atributo nombre. El valor es retornado en un objeto String 
  * Precondición: TRUE 
  * @return El valor del atributo nombre 
  *         En caso de no haber sido asignado retorna null 
  */ 
 public String getNombre() { 
     return nombre; 
 } //Fin Metodo Analizador 



//--------------------------------------------------------------------------------

 /**========================================================================== 
    Encabezado del Método Modificador 
    ========================================================================== 
    * (Objetivo)   : Objetivo del Método. 
    * Precondicion : Condición requerida para la ejecuación correcta del método. 
    * PostCondicion: Condición que puede asegurar que el método se realizó correctamente (aserción) 
    * @param parámetro - Especificación del valor del parámetro. 
    */ 
 //  Ejemplo Modificador: 
 /** 
  * Asigna el valor del parámetro dado al atributo nombre. Asigna este valor inicial o lo remplaza 
  * Precondición: TRUE 
  * Postcondicion: this.nombre == nombre 
  * @param nombre - Nuevo valor del atributo nombre. 
  */ 

 public void setNombre (String nombre) { 
     this.nombre = nombre; 
 } // Fin Metodo Modificador 
  

}// Fin Clase Plantilla