La Documentacion Tecnica es el material que explica las caracteristicas y las operaciones de un sistema. Está documentacion es importante ya que es más facil para el usuario entender el sistema que esta utilizando.
Es muy facil generar la documentación Técnica, ya que se genera automaticamente con ayuda de algunas herramientas como: Sandcastle, Javadoc, Doxygen, Sphinx, etc.
En mi caso, Generare la documentacion Tecnica de mi proyecto con Javadoc, entonces les explicare como generarla en esta herramienta.
Despues de que hice los diagramas en Umbrello, segui algunos pasos para generar el codigo de mi diagrama, esté codigo aparece con comentarios especiales, me refiero a que no son como los que siempre usamos: /* Comentario */, estos comentarios son:
/**
*Comentario
*/
Tambien se ponen algunas palabras reservadas, estás explican la semántica del texto, En este Link, aparecen algunas de estas palabras reservadas.
Para Generarla, entramos en el simbolo del sistema, y escribimos:
"javadoc nombre.java"
con nombre, me refiero a el nombre de nuestro archivo previamente comentarizado, y entonces asi de facil se genera la nuestra documentación Técnica.
No hay comentarios:
Publicar un comentario