Thursday, 13 August 2009

Delphi Code to Doc

En éste post, os muestro la última versión de DelphiCodeToDoc que nos permite generar documentación técnica de nuestro proyecto en formato .html o .chm al igual que hace JavaDoc. Mediante unas etiquetas, podemos crear diferentes descripciones para nuestros métodos y nuestras clases para que sean mucho más entendedoras. Una vez nos hemos decargado la última versión estable de la aplicación DelphiCodeToDoc_exe_v0.23b.zip. Una vez tenemos la última versión, la descomprimimos y solo consiste en ejecutar la aplicación y cargar nuestro proyecto. Si observáis la documentación de DelphiCodeToDoc, comprobaréis los diferentes tags que podemos utilizar en nuestro proyecto para que luego aparezcan en la ayuda.
Para éste ejemplo, utilizaré una de mis aplicaciones para generar la documentación. Aunque no he preparado ningún tag de descripción, podréis ver el formato final de la documentación, que no tiene desperdício.

Ahora, solo tenemos que ejecutar la aplicación DelphiCodeToDoc.exe y llamar al wizard project, desde File -> New Quick Wizard Project. Ahora cargamos los ficheros que nos pide:

Ahora continuamos con la carga de nuestro proyecto, configurando una serie de opciones antes de generar la documentación:

Ahora nos dirigimos a project -> check and build y voilà!, ya tenemos generada la documentación de nuestro proyecto.

Aquí os dejo el documento para que lo podáis descargar y visualizar, para ver el resultado final Thundax Geometry Link.chm.


0 comments:

Post a Comment