La reutilización de código es algo que siempre se debe buscar en la industria del desarrollo de software, mientras mas código pueda ser reutilizado se desarrollara con código de mayor calidad por que este código ya fue probado previamente.
Sin embargo uno de los grandes problemas que tiene el desarrollador es que no documenta, ¿Cual es la desventaja de no documentar? la desventaja es que el código se vuelve un criptico, incluso para el mismo desarrollador que lo programo, un desarrollador puede recordar sus programas por semanas, saber cual es su uso, pero recordarlo por meses o por años, es prácticamente imposible, ademas, el desarrollador va madurando, y conforme madura su estilo de programación cambia, no es lo mismo aquel primer código que escribieron cuando estudiaban que ese ultimo código de su proyecto mas reciente.
Las técnicas de desarrollo cambian, maduran se hacen mas solidas, ademas la capacidad de solucionar problemas evoluciona, como consecuencia su codificación cambia.
Con el correr de los años el código ya no es de ustedes, el código es de una versión previa de ustedes.
Eso cuando hablamos de nuestro propio código, pero ¿Que ocurre cuando es un código heredado? muchas veces una buena solución se desecha por el simple hecho de que no sabemos que existe o desconfiamos de ella.
Resultado, se codifica lo mismo varias veces en diferentes proyectos, bajo el punto de vista de diferentes desarrolladores.
Pero esto ocurre en proyectos "caseros" por que es común ir a buscar frameworks y dll que se encuentren en nuget, que nos solucionan el trabajo.
¿Por que confiar primero en un tercero que en nuestro propio compañero de equipo?
Por una razón muy sencilla, no entendemos su código.
Bueno existen muchas formas de documentar un código, pero ahí viene otro problema, documentación muy compleja, también es enviada al cajón del olvido, se debe buscar una forma en que la documentación sea concisa.
Existen diversas herramientas de documentación, pero hoy hablare de una que nos muestra nuestras clases en un formato que ya es de todos conocido, ¿Por que? por que es el mismo formato con el que se encuentra la ayuda de MSDN, la aplicación se llama GhostDoc, tiene 2 versiones una Comunity que es gratuita y una de paga.
Pueden descargarlo de esta pagina
http://submain.com/products/ghostdoc.aspx
¿Como usarla?
Bueno creemos un proyecto de Visual Studio, una clase de ejemplo
Debemos colocarnos en la parte superior del espacio de nombres, de los métodos de las propiedades, y presionar la secuencia de teclas
Ctr+Mayusculas+D
o ir al menú herramientas->GhostDoc->Document this
Que ocurre, GhostDoc trata de documentar nuestra clase con la información que posee, y si no tiene información nos deja el espacio para que nosotros documentemos
Sin embargo uno de los grandes problemas que tiene el desarrollador es que no documenta, ¿Cual es la desventaja de no documentar? la desventaja es que el código se vuelve un criptico, incluso para el mismo desarrollador que lo programo, un desarrollador puede recordar sus programas por semanas, saber cual es su uso, pero recordarlo por meses o por años, es prácticamente imposible, ademas, el desarrollador va madurando, y conforme madura su estilo de programación cambia, no es lo mismo aquel primer código que escribieron cuando estudiaban que ese ultimo código de su proyecto mas reciente.
Las técnicas de desarrollo cambian, maduran se hacen mas solidas, ademas la capacidad de solucionar problemas evoluciona, como consecuencia su codificación cambia.
Con el correr de los años el código ya no es de ustedes, el código es de una versión previa de ustedes.
Eso cuando hablamos de nuestro propio código, pero ¿Que ocurre cuando es un código heredado? muchas veces una buena solución se desecha por el simple hecho de que no sabemos que existe o desconfiamos de ella.
Resultado, se codifica lo mismo varias veces en diferentes proyectos, bajo el punto de vista de diferentes desarrolladores.
Pero esto ocurre en proyectos "caseros" por que es común ir a buscar frameworks y dll que se encuentren en nuget, que nos solucionan el trabajo.
¿Por que confiar primero en un tercero que en nuestro propio compañero de equipo?
Por una razón muy sencilla, no entendemos su código.
Bueno existen muchas formas de documentar un código, pero ahí viene otro problema, documentación muy compleja, también es enviada al cajón del olvido, se debe buscar una forma en que la documentación sea concisa.
Existen diversas herramientas de documentación, pero hoy hablare de una que nos muestra nuestras clases en un formato que ya es de todos conocido, ¿Por que? por que es el mismo formato con el que se encuentra la ayuda de MSDN, la aplicación se llama GhostDoc, tiene 2 versiones una Comunity que es gratuita y una de paga.
Pueden descargarlo de esta pagina
http://submain.com/products/ghostdoc.aspx
¿Como usarla?
Bueno creemos un proyecto de Visual Studio, una clase de ejemplo
Debemos colocarnos en la parte superior del espacio de nombres, de los métodos de las propiedades, y presionar la secuencia de teclas
Ctr+Mayusculas+D
o ir al menú herramientas->GhostDoc->Document this
Que ocurre, GhostDoc trata de documentar nuestra clase con la información que posee, y si no tiene información nos deja el espacio para que nosotros documentemos
Aquí me diran esto ya lo hace Visual Studio, bueno llenemos los campos de documentación y veremos por que es te gran ayuda esta herramienta
Bien ahora debemos hacer lo siguiente:
Herramientas -> GhostDoc -> Build Help File
Nos mostrara una pantalla de opciones, si tenemos la versión gratuita no podremos modificar nada, demos "OK".
Nos genera un archivo de ayuda
que si lo abrimos nos muestra la documentación de nuestro código en un formato familiar
Felices lineas
No hay comentarios.:
Publicar un comentario