Importancia de la generación de un Manual de desarrollo en los productos de software.

Resumen

Un buen desarrollador al realizar la implementación de un código debe tener presente que el mismo pudiera ser utilizado o modificado, partiendo de que la industria del software va en constante perfeccionamiento. No solo es factible que se realicen comentarios al código y luego se genere un manual de desarrollo, pues el mismo se nutre de esa documentación. Sino, que es de vital importancia la realización de ese manual para un mejor entendimiento por parte de usuarios u otros programadores que desean interactuar con ese código.

Palabras claves: Documentación, implementación, código.

Introducción

En la actualidad las industrias de software se enfocan en la entrega de productos con eficiencia, pero es imprescindible destacar no solo la importancia de distribuir proyectos terminados para su utilización; también es importante que sea entendible el código del producto para un posterior mantenimiento o reutilización. En la FRG (Facultad Regional de Granma) perteneciente a la Universidad de las Ciencias Informáticas, se ha presentado una serie de problemas. A raíz, de que muchos profesores y estudiantes abandonan el centro al finalizar un curso, los cuales se han desempeñado en el desarrollo de proyectos productivos, su trabajo queda y es necesario que el código de sus proyectos sea entendible y pueda ser actualizado por otros desarrolladores. Si el código no está documentado o no hay un manual de desarrollo, esto se hace más difícil y conlleva a una pérdida de tiempo innecesaria. El presente trabajo tiene como objetivo analizar la importancia de la generación de un Manual de Desarrollo en los productos de software basado en la herramienta JavaDoc.

Metodología

Documentación de código

Cuando se hace entrega de un producto al cliente no solo es importante entregarle la parte de ingeniería; también se hace necesario la entrega del código para una posterior utilización, por lo cual es importante que se realice la documentación de código.

La documentación de código es un método efectivo de incrementar la legibilidad del código, permite entender que está escrito y para que se escribió. No solo se puede encontrar dentro del código también en formatos más sencillos como son LATEX, PDF y HTML. Existen varias herramientas que permiten a partir de la documentación de código generar el manual de desarrollo.

Herramientas para documentar código

• JavaDoc
• PHPDoc
• Doxygen

A modo de lograr mejor entendimiento la herramienta posee un estándar para realizar la documentación. Ejemplo de la estructura a seguir para comentar utilizando dicha herramienta.

» Comienzan con los caracteres «/**», se pueden prolongar a lo largo de varias líneas (que probablemente comiencen con el carácter «*») y terminan con los caracteres «*/».

Deben usarse al menos las etiquetas:

• @author (nombre del autor ).
• @version (identificación de la versión y fecha ).
• @see (referencia a otras clases y métodos )
• @param (una por argumento de entrada )
• @return (si el método no es void )
• @exception ó @throws (una por tipo de Exception que se puede lanzar (@exception y @throws se pueden usar indistintamente). » [1]

La documentación se realiza por obligación al principio de cada clase, de cada método o ante de cada variable de clase utilizada. Además es importante que se realice una correcta documentación porque un programa mal documentado se considera inútil. Pues, no cumple los objetivos por lo que se realiza, y es que el programador inicial u otro programador que desee utilizar ese código entienda a través de la documentación la funcionalidad o para que fue implementado ese código.

Partiendo de los comentarios se genera un manual de desarrollo, el cual es práctico y legible; además se nutre de fragmentos de código para facilitar un mejor entendimiento. Siempre y cuando la documentación sea correctamente desarrollada.

Conclusiones

Luego de analizadas las herramientas utilizadas para una correcta documentación de código y la importancia que esto trasciende a lo largo de toda la vida del software. Se determinó que documentar un código a medida que se realiza su implementación es de vital importancia y trae grandes beneficios; porque permite la generación de un Manual de Desarrollo que sirve como ayuda para una mejor comprensión.

Referencias Bibliográficas

[1] A. Mañas, José, Documentación de código. Citado el 6 de abril, 2013

Bibliografía

Combinación de documentación y código. Citado el 10 de abril, 2013.

Importancia de la documentación. Citado el 6 de abril, 2013.