Documentar código

[Gabity]

Hola!! tengo muchas dudas respecto a como empezar a trabajar un programa que documente un código en DELPHI, es decir que dado un código cualquiera realizado en delphi, el programa presente una pantalla, reporte o informe que muestre cuantos procedimientos, funciones, objetos tiene cada unidad de dicho código.. Si tienen algun material de esto, por favor se los agradeceria de verdad.

Atte.
Gabity-Venezuela

[dec]

Hola,

Hace un par de días me interesé por el programa DelphiCodeToDoc que consigue auto-documentar proyectos de Delphi. Puesto que es un proyecto de código abierto podrías echarle un vistazo, creo yo.

Por otro lado no repitas tu pregunta en distintos hilos: no se te va a hacer más caso por eso. Consulta la guía de estilo de estos Foros para más información.

[roman]

También está essmodel que toma un proyecto y lista todas las clases usadas y sus dependencias, además de generar documentación en HTML.

Tambiénes de código abierto.

// Saludos

[Neftali [Germán.Estévez]]

Yo utilizo Time2Help; Añadiendo determinados comentarios al código (o poniendo los que pones en un determinado formato) te genera documentación en diferentes formatos (HTP, HTML, CHM,...). La pega es que es de pago .

[[Lepe]]

Lo que llevo mirado hasta el momento:
Pascal analyzer

El mejor de todos, para mi gusto claro

Dunit

Crea un programa aparte para testear las clases y el programa que estas realizando (jejeje ya vendrán a comentar)

Code formater (open source)

Cuidado con las preferencias, puede quitar los bloques begin..end que cree que no son válidos y cambiar el hilo de ejecución del programa.


DelphiCodeToDoc

crea 400 paginas web con las variables tipos y demás,
muy completo y bonita la documentación final.

Solo hay que especificar el .dpr de delphi

DiagramDesignerSetup

No resulta comodo para programadores, aunque permite crear tu propia librería de objetos para aumentar la paleta de componentes
(electricos, de casos de uso...)


case Studio 2 (database modeling) shareware

Muy Muy currado la exportacion a html.
Detalles de campos, entidades, modelos DFD y ERD (entity)
Permite ingenieria inversa (dada una base de datos, saca las tablas, atributos, campos primarios, indices, longitud y tipo de los campos y mucho más.
Permite conversion de una base de datos a otra.

Icarus beta

Solo hace un analisis de los uses utilizados en un proyecto
El informe generado es para imprimir un Memo con todos los uses.

Pa700 dem (pro-analyzer) demo

Crea 400 paginas web navegables. Destaca el informe Callmap (llamadas de una subrutina a otra)
The following table gives a brief description of the reports generated for the SAMPLE Program. Click on the report symbol to load the report.

Symbol Report name Description
ANM
Anomaly Report A report of unusual conditions detected during processing. Items detected include: variables that were not set, variables that were not used, value params reset & invalid real compares.
DIC
Data Dictionary A list of data elements used by the system in alphabetical order, with their scope, type and definition location.
DUP
Duplicate Identifier Report A list of any duplicate identifiers used, in alphabetical order, with their scope, type and definition location.
FIL
File Content Report A list of the files used by the system and summary of their contents in alphabetical order.
GXR
Global Cross Reference A cross reference of all global identifiers, indicating their usage by subprogram, with their scope, type and references.
HDR
Comment Headers Report A list, in report form, of the subprogram comment blocks that were generated for insertion as headers into the source code.
IXR
Identifier Cross Reference A system cross reference of all identifiers, indicating their usage by subprogram, with their scope, type and references.
LOC
Module Location Report A list of the subprograms used by the system in alphabetical order with their file location.
LST
Source Listing Source code listing with syntax highlighting.
LXR
Local Cross Reference A traditional cross reference by subprogram, an alphabetical list of identifiers, with their scope, type and references.
MAP
Callmap Report A logic map of the program's structure at the subprogram call level. The map may optionally include externals, and brief descriptions of the subprograms. Occurrences of ordinary, mutual and indirect recursion are detected, if present in the program.
OHR
Object Hierarchy Report A diagram of the object hierarchy for the objects encountered in the program.
SRV
Survey Report A survey of the subprograms used in the system. The 'path' count indicates the number of independent paths in the code, a commonly used measure of program complexity. The various line counts give an indication of subprogram size and quality.

[[Lepe]]

Aprovecho la situación para preguntar por un programa que reuna TODO- LIST, BUG LIST, REVISION HISTORY y que preferiblemente sea gratis

¿conoceis algo?

Un saludo

[Neftali [Germán.Estévez]]

Empezado por Lepe

Aprovecho la situación para preguntar por un programa que reuna TODO- LIST, BUG LIST, REVISION HISTORY y que preferiblemente sea gratis

Nosotros utilizamos el JVCS (Jedi Version Control System); Es un programa para controlar versiones de los fuentes, en grupos de trabajo; Incluye las funcionalidades que pides y muchas, muchas más... Lo que no se si es exactamente lo que buscas o es demasiado.

Puedes ver un resumen de lo que tiene aquí:
http://www.freevcs.de/mainfeatures.htm

Algunas imágenes:
http://www.freevcs.de/screenshots.htm

NOTA: Éstas imágenes son del proyecto original, desde hace un tiempo ha pasado a SourceForge en la direccion: http://jedivcs.sourceforge.net/

[Gabity]

Hola!! Dec, muchas gracias por tu ayuda...Respecto a lo de publicar mi pregunta en distintos hilos, eso fue por error, como estoy nueva en este foro me confundi, y luego intente borrarla del otro hilo pero por lo que veo no se borro. Disculpa de todas formas!. Saludos!!

[Gabity]

Hola!! Gracias a todos por la información, voy a revisar lo que me han recomendado, les mantendre al tanto de como va la realización del documentador de código, espero seguir contando con su ayuda. Gracias de nuevo! Saludos!!

[[Lepe]]

Muchisimas gracias Neftali, como siempre tus respuestas son exquisitas

Un saludo

[[Lepe]]

Empezado por roman

También está essmodel que toma un proyecto y lista todas las clases usadas y sus dependencias, además de generar documentación en HTML.

Tambiénes de código abierto.

// Saludos

Pues me gustaría hacer incapié sobre este programa; se me pasó por la mente abrir el archivo Classes.pas de la vcl de delphi. El que haya usado el programa ya sabe el resultado, esquema gráfico de las clases, herencia, propiedades y métodos.

Generar la documentación sobre Classes.pas no tiene mucho sentido, para algo está la ayuda de delphi, pero el diagrama de clases que podemos guardar con extensión png, desde luego es para imprimirlo y forrar toda la habitación con él.

Y lo mejor, se puede integrar en el ide de delphi

saludos

[Val]

Siento retomar un tema abandonado hace tanto tiempo, pero es que me he encontrado esto buscando algún soft para documentar (lo comentado en el hilo) pero para C++. ¿Alguna sugerencia?

Gracias