Alumno: Oscar Madrigal Delgado
El objetivo de esta tarea era, primordialmente, dar a entender la relevancia de una buena documentaci�n para nuestro c�digo, adem�s de la utilidad de saber indentarlo de manera apropiada para una comprensi�n m�s sencilla.
Antes que nada, fue necesario encargarse de reoganizar el
c�digo de la clase Acumulado.h. Esto puesto que a pesar de que en su
estado oiginal era perfectamente utilizable por el compilador, no era
de ninguna manera legible para una persona. Por esta raz�n se debi�
indentar de forma ordenada, siguiendo reglas b�sicas de indentaci�n que
se pueden observar aqu�.
Luego se llevo a cabo la compilaci�n del c�digo en el
compilador DevC++ con todos los archivos necesarios corregidos. No se
report� ning�n error o conflicto y el c�digo pudo ser ejecutado con los
resultados esperados.
Primero que todo, la documentaci�n interna del c�digo usado en
esta tarea, se realiza con Doxygen como herramienta principal. La idea
detr�s de Doxygen, como varias otras herramientas de documentaci�n de
software, es utilizar los comentarios que se agregan al c�digo en
lugares espec�ficos para generar autom�ticamente, en base a un archivo
de configuraci�n, una documentaci�n bastante profesional que sirva de
gu�a tanto para el creador, como para cualquier otro programador que
tenga que trabajar con el c�digo.
Un ejemplo sencillo de la construcci�n de la documentaci�n en Doxygen, es el siguiente:
/** Constructor de vector.
\dontinclude test_Acumulador.cpp
\skipline test::constructor()
\until }}
\see test_Acumulador::test_constructor()
*/
Acumulador () {
borre();
}
El texto en negrita it�lica muestra los comentarios que son le�dos por Doxygen para generar la documentaci�n. En este caso, es aplicado al constructor de la clase Acumulador. Entre la informaci�n que se puede agregar a los comentarios est� una peque�a descripci�n de la funci�n del m�todo, as� como la posibilidad de indicarle el archivo y el c�digo espec�fico de prueba para un m�todo en particular.
La documentaci�n se gener� sin mayores problemas gracias al archivo de configuraci�n con extensi�n DXG. El �nico problema que se present� al generar el folder HTML que contiene toda la documentaci�n, fue que la �ltima versi�n de Doxygen no soporta toda la funcionalidad de la extensi�n para generar la salida en espa�ol, por lo que se producen ciertas cosas en ingl�s, entre mezcladas con espa�ol.
El resultado fue una documentaci�n clara y simple, con todos los datos de prueba respectivos para cada m�todo. Lo que demuestra la efectividad de Doxygen y lo simple que es su uso, para proveernos algo tan valioso como una buena documentaci�n interna profesionalmente estructurada.
