Proyecto Fin de Carrera

Robótica, software y telecomunicaciones.

Dia, AutoDia y Doxygen, herramientas para organizar y documentar

Aunque el Proyecto Fin de Carrera de una Ingeniería Técnica no suele ser de grandes dimensiones siempre es bueno adquirir buenas costumbres desde el principio.

Como ya escribí en esta entrada anterior, fijar los objetivos y una planificación, son buenos hábitos a la hora de desarrollar proyectos.

Cuando el proyecto se trata de software, buenos hábitos son: Organización con UML, Código Limpio y Claro, y Documentación.

Dia Doxygen

UML (Lenguaje Unificado de Modelado) es una de las formas más conocidas de organizar el software en base a procesos, métodos, funciones, etc.

La idea es utilizar diagramas para representar un problema y su solución, de esta forma creamos una especie de mapa del software donde tenemos cómo funciona o como queremos que funciones paso a paso. Crear archivos UML de tu programa te puede ayudar a no perderte en él, a poder mejorarlo después de un largo abandono, o incluso hace más fácil obtener ayuda de otras personas.

Un programa multiplataforma (GNU/Linux, Windows y Mac) para trabajar con diagramas UML es Dia.

AutoDia es un programa que lee el código fuente de tu programa y crea archivos listos para ser editados con Dia, siendo un complemento muy útil para Dia.

La documentación es importante para un programa informático, ya no sólo para saber cómo funciona, sino para saber cómo se usa. Los programas con interfaz gráfica suelen ser fáciles de usar y no necesitan apenas explicación, pero a veces, dependiendo de la aplicación los iconos no dejan tan claro cual es su función y necesitamos recurrir a la ayuda. Más aún en los programas que no tienen interfaz gráfica (programas en consola) ya que no sabemos qué parámetros debemos pasarle, ni la forma.

Un programa que nos permite consultar esto en GNU/Linux es el comando man. Por ejemplo, al escribir en consola: man openoffice nos saldrá la documentación de cómo usarlo, y nos dice que para usarlo por consola el comando es ooffice, que es una suite ofimática, autores, etc.

Gracias a Doxygen podemos crear páginas man para nuestro programa, además de documentación en HTML o en PDF. En el siguiente blog podéis ver cómo configurar Doxygen.

Anuncios

16 noviembre 2009 - Posted by | Recursos | , , , , , ,

1 comentario »

  1. […] y Doxygen aplicado a RoboComp Hace varios meses os hablé de Dia , Autodia y Doxygen. Hoy os contaré cómo podemos aplicar estas herramientas de documentación a […]

    Pingback por Autodia y Doxygen aplicado a RoboComp « Proyecto Fin de Carrera | 3 abril 2011 | Responder


Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

A %d blogueros les gusta esto: