domingo, 9 de octubre de 2011

Documentación técnica

Código

/**
*@author Gemma Tovanche Martínez

*La clase Videoclub es la clase principal.
*/
public class Videoclub{
public Videoclub(){
}

/**
*La clase Empleado es usada para administrar el sistema.
*/
public class Empleado{
private int no_empleado;
private String nom_empleado;
private int contraseña;

/**
*Constructor
*@param nume indica el numero de empleado
*@param nome indica el nombre del empleado
*@param con indica la contraseña del empleado
*/
public Empleado(int nume, String nome, int con){
no_empleado = nume;
nom_empleado=nome;
contraseña = con;
}

/**
*Metodo entrar para que el empleado acceda al sistema.
*/
public void entrar(){
return;
}
/**
*Metodo consultar para que el empleado consulte la base de datos.
*/
public void consultar(){
return;
}
}

/**
*La clase Cliente es usada para registrar a los clientes del Videoclub.
*/
public class Cliente{
private int no_cliente;
private String nom_cliente;
private String colonia;
private String calle;
private int no_dir;
private int cp_dir;
private int tel_cliente;


/**
*Constructor
*@param nomc indica nombre del cliente
*@param col indica colonia de direccion del cliente
*@param calle indica calle de direccion del cliente
*@param no_dir indica numero de direccion del cliente
*@param cp indica codigo postal de direccion del cliente
*/
public Cliente(String nomc, String col, String calle, int no_dir, int cp, int tel){
nom_cliente = nomc;
colonia = col;
calle = calle;
no_dir = no_dir;
cp_dir = cp;
tel_cliente = tel;
}

/**
*El metodo registrar, registra a los clientes del Videoclub.
*/
public void registrar(){
return;
}
}

/**
*La clase Pelicula permite realizar instancias para agregar peliculas a la base de datos.
*/
public class Pelicula{
protected int no_pel;
protected String titulo;
private String material;
private String situacion;
private String genero;
private String clasificacion;
protected double costoVta;
protected double costoRta;
private int cantpel_vta;
private int cantpel_rta;

/**
*Constructor
*@param numpel indica el numero de pelicula que se le asigna a cada pelicula
*/
public Pelicula(int numpel){
no_pel = numpel;
}
/**
*El metodo vender realiza la venta de peliculas.
*/
protected void vender(){
return;
}
/**
*El metodo rentar realiza la renta de peliculas.
*/
protected void rentar(){
return;
}
/**
*El metodo agregar realiza el registro de cada pelicula que se da de alta.
*/
public void agregar(){
return;
}
/**
*El metodo eliminar da de baja a peliculas.
*/
public void eliminar(){
return;
}
}

/**
*La clase Ticket hereda de la superclase Pelicula.
*La clase Ticket realiza el ticket que se producira al realizar una venta y/o renta.
*/
public class Ticket extends Pelicula{
private int no_tick;
private int no_cliente;
private int no_empleado;
private String nom_empleado;
private int cantPeliculas;
private String fecha;
private double subtotal;
private double total;
private String fechaLimRta;
private String fechaEntrega;
private double multa;

/**
*Constructor
*@param no_tick indica el numero de ticket que se le asigna a cada ticket
*/
public Ticket(int no_tick){
no_tick = no_tick;
}
/**
*El metodo imprimir muestra el ticket que se genero al realizarse una venta y/o renta.
*/
public void imprimir(){
return;
}
/**
*El metodo vender realiza la venta de peliculas.
*/
public void vender(){
super.vender();
return;
}
/**
*El metodo rentar realiza la renta de peliculas.
*/
public void rentar(){
super.rentar();
return;
}
}

public static void main(String[] args){
}
}

Para realizar la documentación de mi proyecto utilice JavaDoc.
Al estar en la terminal en la carpeta donde se encuentra mi proyecto en Java, teclee lo siguiente para la generación de la documentación:
javadoc *.java
Después se generaron una serie de archivos HTML, entre los cuales hay uno llamado index.html, el cual contiene la clase principal Videoclub y las demás clases del proyecto.
La siguiente imagen es una captura del archivo index.html.


Las imagenes de las capturas de la documentación de las demás clases del proyecto son las siguientes:

Clase Cliente
Clase Empleado
Clase Película
Clase Ticket
Las imagenes anteriores de la documentación muestran una parte de la documentación.

La documentación completa se encuentra aquí: Documentación

Saludos.


1 comentario:

Sara E. Garza dijo...

Bien.

Calificación: 5/5

Publicar un comentario