herramientas de documentacion de software

República Bolivariana de Venezuela
Ministerio del Poder Popular para la Educación
Universidad Nacional Experimental de Guayana
Proyecto de Carrera: Ingeniería en Informática
Unidad Curricular: Técnicas de Programación III
Sección 01

HERRAMIENTAS DE
DOCUMENTACIÓN DE
SOFTWARE

Profesor:
Carlos Abaffy

Integrantes:
Vicmar Rojas

C.I: 26.562.875

Ricardo Vásquez C.I: 26.073.680
Yurek Turowiecki C.I:26.048.613
Carlos Torres

C.I: 20.505.989

Aldrin Salazar

C.I: 26.262.738

Puerto Ordaz, 10 de Julio de 2015

INTRODUCCIÓN
Un programa bien documentado brinda a los usuarios finales toda la
información sobre los aspectos y características de este de una manera precisa,
concisa y relevante. A su vez, permite la conservación de la historia del software,
facilita su utilización por parte delusuario final y también garantiza su
permanencia.
El papel de la documentación en un entorno de ingeniería de software es
comunicar información a su público e inculcar el conocimiento del sistema que
describe. La documentación debe permitir de manera eficiente para el futuro
desarrollo
de
software
sin
obstaculizar
el
progreso
actual.
El problema a la hora de realizar la documentación de un software esque
puede volverse una tarea algo tediosa si se trata de un programa muy extenso o
si esta es muy detallada. Es por esto que surgió la idea de crear herramientas
software que ayudaran en la generación prácticamente automática de la
documentación de los programas.

HERRAMIENTAS DE DOCUMENTACIÓN DE SOFTWARE
Definición
Para realizar la documentación sobre un programa los editores de texto que
usamosgeneralmente para redactar documentos pueden considerarse como
herramientas. Microsoft Word, Writer de OpenOffice, Block de Notas, NotePad++,
entre muchos otros, son de utilidad a la hora de escribir documentación de
software. Claro está, que para una documentación extensa estas herramientas se
vuelven obsoletas y resultan en un gran consumo de tiempo y recursos.
Para estos casos donde el códigoa documentar es grande, existen otras
herramientas, la cuales se definen como programas capaces de generar
automáticamente documentación de software mediante la extracción de
información del propio código fuente. Las herramientas que existen actualmente
obtienen esta información por medio de directivas en forma de comentarios en el
código. Cabe destacar que hay que tener conocimientos sobre cómodar dichas
directivas.
Actualmente en el mercado existen diversas herramientas que cumplen con
esta funcionalidad. Entre estas podemos mencionar a Naturaldocs, Robodocs,
Doxygen y JavaDoc que viene integrada por defecto en varios IDEs para
programar en Java como NetBeans y Eclipse. A continuación se especificaran las
dos últimas herramientas.
Doxygen
Doxygen es un programa generador dedocumentación para C++, C, Java,
Objective-C, Phyton, VHDL y en ciertas partes también para PHP y C#. Funciona
en la mayoría de los sistemas Unix al igual que en Windows y Mac OS. Su
nombre es un acrónimo de dox (document) y gen (generator), traducido al español
como generador de documentación, en este caso, para código fuente.
Este programa analiza el código en búsqueda de comentarios y los
transforma endocumentación, ya sea HTML o bien LaTeX. Su principal ventaja es
principalmente esta, las directivas que utiliza no son más que los comentarios en
el código, de forma que no es necesario crear otra documentación aparte, solo es
necesario comentar el código.
Hay que estar consientes en lo que deben incluir los comentarios para que la
documentación sea más precisa. Por ello, estos deben contener losiguiente:
De qué se encarga una clase.
De qué se encarga un paquete.

Qué hace un método.
Cuál es el uso esperado de un método.
Para qué se usa una variable y cuál es el uso esperado de esta.
Qué algoritmo estamos usando y de dónde lo hemos sacado.
Qué limitaciones tiene el algoritmo.
Estos comentarios deben colocarse:
Por obligación:
Al principio de cada clase.
Al principio de cada método.
Ante...