Doxygen

Doxygen Es una herramienta que facilita inculcar el hábito de especificar antes de implementar en los programadores novatos. Creador JCSC 2 Fecha de Creación 2011

Doxygen es una herramienta que facilita inculcar el hábito de especificar antes de implementar en los programadores novatos. Tiene la cualidad de que funciona para muchos lenguajes y plataformas. Es de uso fácil por lo que es la herramienta ideal para ser usada con principiantes. Es un generador de documentación para C++, C, Java, Objective-C, Python, IDL (versiones Corba y Microsoft) y en cierta medida para PHP, C# y D. Dado que es fácilmente adaptable, funciona en la mayoría de sistemas Unix así como en Windows y Mac OS X. La mayor parte del código de Doxygen está escrita por Dimitri van Heesch.

El generador de documentación de código fuente Doxygen

Es una buena ocasión para presentar muy brevemente un utilitario que no puede faltar en ninguna «caja de herramientas» de un buen programador. Doxygen es un programa que permite documentar fácilmente el código a través de un sistema de «comentarios-tags». Así por ejemplo, los usuarios de Javadoc, por ejemplo, encontraran que disponen de un procedimiento de 170 tags por defecto, en un sistema que les permitirá agregar los propios a los efectos de responder a las necesidades de un proyecto.

Aparte de ello, de la documentación de las fuentes (prototipo de funciones, de las clases) podemos obtener las siguientes informaciones:

• Listado de archivos incluidos
•  Documentación de las estructuras de datos
• Jerarquía de las clases
•  Diferentes tipos de gráficos: diagrama de clases, de colaboraciones, de llamadas, de inclusión, etc.
• Un index de todos los identificadores
•  Los archivos fuente anotados

Toda la documentación producida generalmente es en formato HTML, a causa de su facilidad de utilización, sin embargo también es posible obtener archivos de formato LATEX, PostScript, PDF, XML, man e incluso Word y CHM. Una gran parte de Doxygen ha sido escrita por Dimitri van Heesch, quien en su época encontraba a la documentación generada por Qt como muy bonita y doc++ como demasiado limitada para un trabajo similar. Hoy, Doxygen soporta C/C++, Java (Corba y Microsoft) Java, Python, IDL, C#, Objetive-C y en parte D y PHP. Doxygen esta distribuido bajo licencia GNU GPL, esta disponible un binario para Windows 95 / XP y para Mac OS X, pero necesita la librería libqt.

Soporte comercial

Doxygen

Actualmente se investiga las posibilidades de prestar apoyo comercial para doxygen. Las formas de apoyo son:

•  Implementación de las funciones
•   Corregir errores.
  

Resumen

Para la mayor parte de los programadores la codificación de algoritmos es la parte más interesante de la construcción de programas; los programadores trabajamos creando mundos virtuales, en donde todas las variables coexisten bajo nuestro perfecto control: esta es la parte más creativa del trabajo del programador. Para construir programas los programadores usamos muchos trucos, desde el uso de estructuras de datos y algoritmos avanzados, hasta la aplicación de convenciones como las descritas en [DiM-1988], que facilitan la labor de programación y mantenimiento del programa.

El camino más sencillo es que al escribir su implementación, deben asegurarse de cumplirsiempre con estas 3 políticas de programación, que se  considera las más importantes:

1. Es muy importante que el programa esté correctamente identificado y que las instrucciones estén debidamente espaciadas.
2. Es muy importante que en todo el programa haya buena documentación interna.
3. Uso de Doxygen para la especificación de todos los métodos, funciones y campos de la clase.
Se debe  saber cuál es la forma de calificar proyectos programados. Específicamente, se concentran en encontrar fallas que quiebren alguna de estas 5 reglas:

1. La falta de cualquier especificación debe ser castigada fuertemente.
2. Correcta Identificación del código fuente.
3. Correcto espaciado del código fuente.
4. Código fuente escrito de manera que sea legible y claro.
5. Uso de identificadores significativos.

Configuración Doxygen

Doxygen es un sistema de documentación para C++, C, Java, Objective-C, Python, IDL (Corba y los sabores Microsoft) y, hasta cierto punto, para PHP, C# y D. La ventaja principal de usar Doxygen en los cursos universitarios es que le permite al estudiante obtener entrenamiento en el uso herramientas que ayudan a generar documentación con la ventaja adicional de que Doxygen es aplicable a un rango muy amplio de lenguajes, lo que no ocurre con herramientas de aplicación específica como Javadoc [KNDK-1997]. Cuando el estudiante termina sus estudios universitarios y pase a su carrera profesional, su entrenamiento Doxygen le permitirá usar con comodidad cualquier otra herramienta de documentación, inclusive Javadoc, cuyo formato es compatible con Doxygen.

Ejemplo 1

PROJECT_NAME = "Prueba de la clase rational:"
OUTPUT_LANGUAGE = Spanish
OUTPUT_DIRECTORY = .
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = YES
INPUT_ENCODING = ISO-8859-1
INPUT = rational.h rational.cpp rat-calc.cpp \ rat-tst.cpp ADH_port.h
RECURSIVE = NO
QUIET = YES
JAVADOC_AUTOBRIEF = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = YES
INLINE_INHERITED_MEMB = YES
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = NO
REFERENCED_BY_RELATION= NO
REFERENCES_RELATION = NO
FULL_PATH_NAMES = NO
SORT_MEMBER_DOCS = NO
SORT_BRIEF_DOCS = NO
CLASS_DIAGRAMS = YES
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = "DOXYGEN_COMMENT" \
 "Spanish_dox" \
"__cplusplus" \
"_MSC_VER=1300" \
"OPEN_namespace(N)=namespace N {" \
"CLOSE_namespace(N)=}" \
"USIGN_namespace(N)=using namespace N"

Fuentes

• http://es.wikipedia.org/wiki/Doxygen
• http://www.di-mare.com/adolfo/p/Doxygen.htm
• http://www.doxygen.org/manual.html
• http://www.di-mare.com/adolfo/p/Matrix/classMx_1_1Matrix.html
• http://www.di-mare.com/adolfo/p/rational/classADH_1_1rational.html
• http://www.doxygen.org/manual.html