delphi - help - docwiki embarcadero

Documentando Delphi

Question

¿Existe una buena herramienta para escanear un proyecto Delphi y organizar unidades, formularios, etc. Tal vez podría bajar al nivel de procedimiento y decir salida a Word o RTF.

Esto me permitiría obtener una primera documentación de corte para un producto grande.

Answer 1

Creo que la mejor herramienta para documentar Delphi es PasDoc .

Además de proporcionarle un documento HTML o CHM con un índice muy bien estructurado de todas las clases, métodos y propiedades que tiene en su código, permite comentarios de código como este:

{
@abstract(Concatenate two strings)
@param(AStringA The first string to concatenate)
@param(AStringB The second string to concatenate)
@returns(The concatenated string)
}
function Concatenate(AStringA, AStringB : string) : string;

Aquí tiene la documentación de salida para el PasDoc mismo. , etiquetas compatibles y la página de descarga . También es de código abierto y, obviamente, escrito en Delphi

Answer 2

Sí, se llama código Delphi a doc , usa etiquetas de estilo javaDoc para producir un archivo de ayuda de Windows.

Pero para sacarle el máximo provecho necesitará todos los comentarios de función / procedimiento / clase etc. en javadoc para, por ejemplo,

{**
*  @auther your name
*  description your description here
*}

Lo uso en nuestro gran código base en el trabajo, pero lleva mucho tiempo unificar los comentarios en el formato correcto.

EDITAR: y es totalmente gratis: D

Answer 3

Desde Delphi 2005 es compilación en el compilador Delphi. Utiliza el estándar XMLDoc que utiliza comentarios de estilo XML. Ver http://dn.codegear.com/article/32770 y http://tondrej.blogspot.com/2006/03/xml-documentation-in-delphi-2006.html

Answer 4

Un lugar desde donde partir para obtener un código heredado sería la arqueología de software, utilizando algunas de las medidas y métricas integradas de Delphi 2007/2009. Escuche Introducción a la arqueología de software en las repeticiones de CodeRage II .

Answer 5

Otra opción sería Pascal Browser (PAB) desde http://www.peganza.com/#PAB
También vale la pena echar un vistazo al Analizador Pascal de Peganza.

Answer 6

Ayuda Scribble tiene una característica bastante buena que le permite apuntar a un archivo dpr y crea un archivo de ayuda de Windows completo con la estructura de su código. Tiene un formato estándar que se puede utilizar para garantizar que obtenga la información correcta de cada unidad, clase y función. Es bastante rápido y efectivo.

Answer 7

Estoy usando JADD - Just Another DelphiDoc de vez en cuando porque se puede usar para generar diagramas de clase rápidamente. Pero no es totalmente compatible con las versiones más recientes de Delphi. Aquí hay un ejemplo de un diagrama muy simple .

Answer 8

Ayuda y manual tiene excelente soporte de documentación de Delphi . También hay una buena herramienta de captura de pantalla y manipulación de imágenes (recorte / sombreado, etc.) que está integrada en el paquete.

Answer 9

También puedes probar SynProject desde Synopse:

http://synopse.info/fossil/wiki?name=SynProject

Esto parece proporcionar capacidades completas de documentación / gestión, así como el análisis fuente para la salida a html o pdf.