G.Bordel >Docencia >TAP | Técnicas Actuales de Programación | (curso 2010-2011) | |||||||
|
|||||||||
tema_anterior | Tema 2: Uso del entorno de desarrollo | tema_siguiente |
2.4- Generación de documentación
Como se ha mencionado al final del apartado dedicado a las bibliotecas de clases, es de vital importancia para un
proyecto de software la generación de documentación, y Java dispone de un mecanismo adecuado para aplicar a la
documentación de las clases. Se trata de un programa (javadoc
) que analiza el código fuente de las
clases que le aportemos como parámetros y estudia su contenido y relaciones dando como resultado un conjunto de páginas
en HTML con un estilo y estructura predeterminados. El contenido de estas páginas se extrae del mismo código fuente
(por lo que la consistencia está asegurada) y en el se incluyen ciertos comentarios que el programador puede
incluir a tal fin (comentarios de documentación).
El programa javadoc
dispone de un buen número de opciones para controlar el nivel de detalle de la
información reflejada como resultado, pero no entraremos por el momento en ello pues hace falta conocer más del
lenguaje. Veremos simplemente un ejemplo muy simple a continuación: se ha escrito una clase par realizar una tarea
específica y se ha generado su documentación con objeto de que otros programadores la utilicen. Obsérvese que no
se ha obtenido sólo una página documentando la clase, sino todo un conjunto de ellas estructurado de un modo
estándar y que permite situar dicha clase en su entorno (paquete, jerarquía, ... ya veremos)
código fuente de "AN1.java" .Comprobar el resultado de "javadoc AN1.java" .
|
Siguiente punto: 2.5- Desensamblado y decompilación
Plataforma de soporte a curso y contenidos (c) German Bordel 2005. |