Que tal!
En esta entrada hablare de la importancia que tiene la documentacion.
Bueno primero empezemos ¿preguntandonos que es documentar? según las sabias palabras de google dice:
Documentar.-
*Probar, justificar la verdad de algo con documentos
*El proceso de implantación del sistema de ayuda en la organización Planeación de la implantación del sistema de ayuda Documentación de los procedimientos, insumos y resultados de la implantación del sistema de ayuda.
Con estas definiciones ya nos damos una idea de lo que es documentar, cuando nosotros compramos un articulo o compramos un servicio pero no sabemos muy bien utilizarlo o de plano no sabemos pues el proveedor de ese dicho articulo o servicio nos tiene que proporcionar un manual, o instructivo para asi nosotros poder darle un uso eficiente.
Ahora como desarrolladores nosotros nos convertimos en proveedores de dicho servicio, entonces, nos corresponde dar una documentacion que demuestre el funcionamiento de nuestro sistema en una forma clara a nuestro cliente.
Como mi proyecto lo estoy desarrollando en java, la herramienta que utilizo es javadoc, esta herramienta nos permite generar documentacion apartir de nuestro codigo poniendo comentarios dentro de el, de una manera muy sencilla
Ejemplo:
/** Esto
* es un
*comentario
*/
para generar la documentacion desde la terminal la sintaxis es asi:
javadoc ubicacion
Esto es todo por el momento en el taller pegare las imagenes de como generar la documentacion.
Gracias :D
Pues, brevecito, pero sí lo complementas con lo que está puesto en el taller. Te pongo 4.
ResponderEliminar