Documentación y herramientas de desarrollo

Actividades de semana 4

La documentación es la información que ayuda a reducir la dependencia entre software y el programador, sin la documentación se tendría que releer el código y mantener la esperanza de entender lo que hace cada sección, algo no muy eficiente.

En otras palabras, la documentación es lo que señala cómo operar un sistema o software, nos permite interpretar errores, y  construir sobre lo ya hecho, rápidamente.

Sin la documentación no se sabe cuál será el comportamiento del resto del sistema aún cuando se hayan descubierto el funcionamiento de ciertos métodos o acciones.

Existen distintos tipos de documentación y distintas formas de documentar, entre los tipos de documentación están los manuales, el manual técnico, que ayuda a los programadores, y el manual de usuario, que se enfoca en los usuarios finales y la información debe de estar expresada en una manera clara y concisa.

Mi proyecto será documentado automáticamente con el uso de un programa llamado javadoc, el cuál leerá el código fuente del programa, identificara e interpretará el formato de los comentarios del lenguaje y generará a partir de eso una página html de fácil navegación con la información de los archivos.

Javadoc identifica cierto formato en los comentarios del código fuente del programa, reconoce las líneas iniciadas con el sígno "at" (@), seguido del nombre del tag o etiqueta que se desea.


Las etiquetas son:

Etiqueta	Introducido en JDK/SDK
@author	1.0
{@docRoot}	1.3
@deprecated	1.0
@exception	1.0
{@link}	1.2
@param	1.0
@return	1.0
@see	1.0
@serial	1.2
@serialData	1.2
@serialField	1.2
@since	1.1
@throws	1.2
@version	1.0

Así documentaría mi proyecto, comentando con las etiquetas y usando el comando javadoc ../*.java

Guía de uso de Javadoc
Ejemplos con Javadoc
Descargar Javadoc


Bibliografía
http://www.elcodigok.com.ar/2009/02/la-importancia-de-la-documentacion-en-nuestros-sistemas/
http://riie.com.ar/?a=31420
http://www.desarrolloweb.com/articulos/importancia-documentacion.html
http://download.oracle.com/javase/1.3/docs/tooldocs/solaris/javadoc.html
http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html