Semana 4 Programacion OO - Documentación y herramientas de desarrollo

Hola... esta entrada es para la semana 4 de programacion orientada a objetos y hablaremos de documentacion en el diseño de Software y herramientas para su desarrollo...

Comunmente la documentacion de Softwares se realiza con archivos html y con txt dependiendo el metodo en el que se documente.

Es importante llevar la documentacion del codigo porque con esto podemos saber que cambios, como funciona y como esta formado el codigo, tambien sirve para cuando se esta trabajando en equipo o en grupo, es nesesario recordar que en documentacion de Javadoc solo va a mostrar la clases publicas, cuando usamos SVN cualquiera que puede entrar al svn  puede ver todo el codigo.

Existen varias formas para documentar el desarrollo de un Software.

Comunmente se utiliza lo que es un ChangeLog que cada cambio que se realize al codigo es añadido ahi con un comentario del resultado.

Otra forma de documentacion es el Subversion o SVN que esta es una pagina en la que se comparte el codigo a todos los que tengan acceso al svn y solo puede ser editado por los administradores o desarrolladores del proyecto, creo que este es un muy buen metodo porque en un svn puedes ver los cambios realizados, y tambien se puede comparar con el codigo anterior.
http://es.wikipedia.org/wiki/Subversion Para ver mas informacion.
http://svn.tech1.org/ Este Link puede servir como demo.

JavaDoc: sinceramente este metodo no lo conocia hasta la semana 4 y me parece un metodo muy simple, eficaz y gratuito. Este metodo explica claramente cada parte del codigo y sin la nesesidad de mostrarlo puedes ayudar a otras personas.

Para generar APIs con Javadoc han de usarse etiquetas (tag's) de HTML o ciertas palabras reservadas precedidas por el caracter "@".
Estas etiquetas se escriben al principio de cada clase, miembro o método, dependiendo de qué objeto se desee describir, mediante un comentario iniciado con "/**" y acabado con "*/".

Para compilar en Javadoc no es nesesario instalar algun paquete para Linux, solo es nesesario abrir la terminal y teclear javadoc *.java y la terminal mostrara la creacion de los archivos y si existe algun error.

http://es.wikipedia.org/wiki/Javadoc
http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html 

Algo.java

package docdemo;

import javax.swing.JFrame;

/** Esta clase no tiene sentido sino simplemente 
 * demuestra la manera
 * en la cual ponemos comentarios que se usan para generar la
 * documentacion en HTML sobre las clases en Java. */
public class Algo extends JFrame implements Comparable {

    /** Este es el metodo que exige la interfaz Comparable. 
     * No esta
     * bien implementado, ya que es puramente un ejemplo de
     * documentacion. 
     * @param o El objeto contra el cual estamos comparando.
     * @return Negativo si esta instancia viene antes del 
     * parametro, cero si son iguales y positivo en otro 
     * caso.
     */
    public int compareTo(Object o) { 
 return -1; 
    }

    /** Este es un atributo para poner un numero. */
    protected static int numero;

}

Este es el ejemplo visto en clase. Aqui se muestra como funciona el codigo y que debe llevar.



Saludos ;]