Documentación y herramientas de desarrollo(taller)

Muy buen día.

Esta semana nos toco hablar de la documentación de los códigos así que para la clase de taller fabrique una documentación de mi avance del proyecto.

Para esto utilice "javadoc" que es una herramienta que viene por defecto en el kit de desarrollo de java este toma todos los comentarios de nuestro código y lo pasa a un HTML donde queda listo para presentarlo.

como puede verse se crea la documentación tal cual se compila un archivo solo que se utiliza el programa "javadoc".

Sin mas aquí pongo el enlace a mi documentación:

http://www.maxkalavera.iblogger.org/


Aquí el estado actual de el código.

Clase

package textedit;
/**
*Clase que sirve de interfaz grafica para un programa podria utilizarse como base
*para cualquier programa, esta se encarga de dibujar una ventana en la pantalla y
*agregar diferentes elementos y controlarlos.
* @author Max Hernandez
*/
public class GUI extends javax.swing.JFrame{

private int numerodeBotones;
/**
* Es la clase que prepara todos los componentes para e imprime en la pantalla.
*/
public void dibujar(){}
/**
* Este metodo se encarga de cambiar la posición de los elementos en la pantalla.
* @param elemt numero que identifica el elemento.
* @param cord cordenada de a donde se desea mover el elemento
* @return cordenada Regresa la cordenada en la pantalla del elemento movido o un -1 si no se puede mover
*/
public int moverElemento(){}
/**
* Alamacena y gestiona la posicion en la pantalla de los elementos cuales deses sean añadidos.
* @return cordenada
*/
public void gestorElemento(){}
/**
* Recibe elementos y les da un lugar en la pantalla para despues ser gestionado.
*/
public void anadirElemento(){}

}

Clase

package textedit;
import java.nio.charset.Charset;
import java.io.*;
/**
* Clase que verifica la códificacion de un arcvhio y despues regresa el contenido de este.
* @author Max Hernandez
*/
public class Reader extends java.io.InputStreamReader {
// Atributos
private String[] nameFile;
private String[] extension;

//Constructor
public Reader(String[] name, String[] ext, File fl){
super(fl);
this.nameFile = name;
this.extension = ext;
}

/**
* prepara el texto para ser pedido por la clase Administradora de texto.
*/
void lector(){}
/**
* Revisa la codificación de caracteres del archivo.
*/
private void decodificador(){}
/**
* Devuelve el contenido de el documento en un estado con el cual es facil para un programa trabajar.
*/
private void devolverDocumento(){}

}

Clase

package textedit;
import java.io.*;
/**
* La funcionalidad de esta clase va orientada a la impresion de datos
* en un archivo de texto, revisa la códificacion de caracteres y tiene los metodos
* necesarios para obtener.
* @author Max Hernandez
*/
public class Writer extends java.io.OutputStreamWriter {

// atributos
private String[] nombreDelArchivo;
private String[] extension;
private int numeroDeLineas;
/**
* Constructor que ocupa la direccion del archivo con la informacion dada.
*/
public Writer (String []nombreDelArchivo, File fl){
super(fl);
}
/**
* Guarda en un archivo la informacion que se le es mandada caracter por caracter con su codificacion
* que le es mandada.
*/
private void guardar(String[] nombreDelarchivo, String[] extencion, String[] datos){}
}

Clase

package textedit;
/**
* Gestiona el editor de texto para que funcione correctamente y junta diferentes partes.
* @author Max Hernandez
*
*/
public class Main{
/**
*/
String[] usuario;

void Main(){};
/**
* Crea un archivo con las opciones de usuario.
*/
public void opciones(){}
public static void main(String[] args ){
System.out.println("Working...");

}
}

Clase

package textedit;

/**
* Esta clase es una extencion de una herramienta que sirve de interfaz
* entre el usuario y el programa. Es una area donde se ingresa y se edita
* el texto de archivos.
*@author Max Hernandez
*/
public class Sheet extends javax.swing.JTextArea { // Una pare de la interfaz grafica y sabe estructurar el texto en la pantalla

private int numeroLineas(){}

/**
* Método que se encarga de imprimir el texto en la pantalla.
*/
void dibujar(){} // lo que sea que le manden
/**
* Verifica el área de texto para ver las modificaciónes hechas por el usuario al texto.
*/

}

Clase

package textedit;
/**
* Sirve para trabajar con el texto de un archivo y prepararlo para imprimirlo en la pantalla o en una hoja.
* @author Max Hernandez
*/
public class TextManager{

String[] nombreDeArchivos;
String[] extension;

/**
* Buscar elementos en un texto
*/
public void buscar();
/**
* Organiza el texto para mas sensilla modificación.
*/
public void acomodarTexto();

}