jueves, 17 de febrero de 2011

Documentación JAVADOC (TALLER)

Aquí está la representación de la documentación de la Clase Producto de mi programa.

Como lo mencione en entradas pasadas, modificaría considerablemente el diseño de mi código y adjunto aquí algo de mi avance:


/**
*This class will control all the atributes of the products that the system is going to
administer.
*/
public class Producto {



   String nombre; // name of product (this is only for tests)
    int numProducto; // id of the product
    float precio; // cost
    int numEscoba; // indicator of avalability for this product
    int numTrapeador; // indicator of avalibity for this product


    Producto(String nombre, int precio){
 this.nombre = nombre;                  // this is for tests
 this.precio = precio;
    }



void asignarExistencia (int e) {

 existencia = e;

    }

    Trapeador trapeador = new Trapeador ( "Trapeador", 16);     // part of the tests
    trapeador.asignarExistencia(100);

    Escoba escoba = new Escoba ( "Escoba", 15);
    escoba.asignarExistencia(100);

Pruebas agregar funcion MAIN





/**This toString will returns a representation of the data of the products.
*/
   public String toString() {
        return "Num. empleado " + numProducto + " Nombre: " + nombre +  //part of the tests
                " Sueldo: " + precio;
    }


/**This method check the availability of the products return true if there 
exists enough products form a sale or return false if there are not 
any more products.
*/


protected boolean disponibilidad(String producto){
 if((producto == "trapeador")&&numTrapeador!=0){
  return true;
 }
 else
 if((producto == "escoba")&&numTrapeador!=0){
  return true;
 }
 else{
  return false;
  
 /*System.out.println("No hay "+producto+"s disponibles");*/
 }
 
 }

}





La compilación y generación del JAVADOC de la clase:


Y aquí el resultado final de la documentación de la clase:
  

Y los detalles de los métodos que contiene la clase hasta el momento.

 


Saludos!! =D

1 comentario:

  1. Faltan un chorro de comentarios javadoc. Checa bien cómo deberían estar documentados los atributos y los métodos. Te pongo 3.

    ResponderEliminar