Code-Dokumentation für delphi ähnlich wie javadoc oder c # xml doc

StackOverflow https://stackoverflow.com/questions/236047

  •  04-07-2019
  •  | 
  •  

Frage

Ich brauche einen Code Dokumentations ähnlich wie javadoc oder c # xml doc für delphi-Code. Was ist das beste Werkzeug? Ich ziehe es eine Technologie, die in Zukunft kompatibel zum Microsoft Sandburg Projekt ist.

War es hilfreich?

Lösung

Hier finden Sie aktuelle SynProject , ein Open-Source-Tool in Delphi geschrieben.

Es wurde entwickelt, um eine vollständige Dokumentation Workflow zu handhaben, von den Spezifikationen Hinweise zu lösen, einschließlich Tests, Architektur und Design; und natürlich gibt es ein integriertes Delphi-Parser-Architektur-Dokumentation von vorhandenen Delphi-Quellcode zu generieren.

Für die Architektur-Dokument kann der Quellcode Kommentare extrahieren (ala PasDoc) einbetten dann diesen Text in das Haupt Architektur Dokument (mit Klassenhierarchie Diagramme und Einheit Abhängigkeiten).

Sie schreiben eine einfache Textdatei eine Wiki-ähnliche Syntax in einem eigenen Texteditor, erstellt SynProject auch Word-Dokumente von ihm formated. Einige Wizards sind verfügbar, um die Inhalte zuzugreifen. Aber da es als einfache Datei gespeichert ist, mehrere Programmierer darauf schreiben kann, unter Verwendung eines beliebigen SCM-Tool (SVN, Fossil ...).

Zum Beispiel, ich benutze es zur Zeit für das Schreiben von Wartungsdokumentation für eine große und alte Delphi-Anwendung (etwa 2.000.000 Zeilen Code geschrieben in Delphi 5 und 6), ohne vorherige verfügbare Dokumentation. Sie beschreiben die auf den Code vorgenommenen Änderungen (unter Angabe der Einheit / Klasse / Methode), dann wird das Tool alle Dokumentationen aktualisieren, zu reflektieren und diese Änderungen zu verfolgen. SynProject wurde entwickelt, um mit einigen sehr „zart“ Verordnung Regeln (IEC 62304) konform zu sein, sondern kann für jedes Projekt aufgrund seines einzigartigen „flat“ Design verwendet werden.

Hinweis : Ich dies eine lange Zeit nach der Frage bin Entsendung, weil SynProject zu diesem Zeitpunkt nicht vorlag, wurde, und kann auf einen Blick wert sein. Dieser Thread hat als Referenz für diese Frage definiert wurde.

Andere Tipps

Delphi + JavaDoc = DelphiCodeToDoc

Soweit mir bekannt ist, gibt es kein Werkzeug leicht kompatibel mit Microsoft Sandcastle - zumindest bis jemand tatsächlich einen schreiben stört, zu modifizieren, eine bestehende oder eine Werkzeugkette zu schaffen, um richtig die Ausgabe zu umwandeln

Ich habe persönlich PasDoc mit großem Erfolg eingesetzt. Ich empfehle die neueste SVN-Version bauen, da die aktuelle Version krächzt gelegentlich auf komplizierte Schnittstellendefinitionen.

Versuchen: - Doxygen Dokumentation - Pas2Dox

Seit Delphi 2005 ist es in den Delphi-Compiler zu bauen. Es nutzt den XMLDoc Standard, die XML-Stil Kommentare verwendet. Ebenso wie C # tut, also denke ich, Sandcastle damit umgehen kann. Siehe http://dn.codegear.com/article/32770 und http://tondrej.blogspot.com/2006/03/xml-documentation -in-delphi-2006.html

Siehe auch Dokumentieren Delphi

Sandcastle benötigt Zugriff auf die Baugruppen zu erhalten, um es zu erzeugen, in der Dokumentation, was bedeutet, dass es nur für .net Sprachen ist (obwohl ich nicht sicher in der Lage Delphi.Net bin). Allerdings Delphi 2007 und 2009 haben eine Inline-XML-Dokumentation sehr ähnlich zu C #. Wenn Sie ‚generieren XML-Dokumentation‘ Option in den Projektoptionen, wird es XML-Dokumentation baut auf diesen Kommentaren basierte Einschalten der. XSLT kann dann verwendet werden, um zu erzeugen, was Dokumentationsformat Sie benötigen (dies ist die schwierige Bit).

DelphiCodeToDoc hat auch eine Befehlszeile, es zu benutzen mit kontinuierlichem Integrations-Tool (zum Beispiel).

Die Frage ist ziemlich alt, aber ich hatte das gleiche Problem heute und diesen Beitrag vorhanden. Delphi 2007 kann folgende Syntax, die die C # Dokumentationen gleich zu sein scheint: 

/// <summary>
/// Summary of the function / class
/// </summary>
/// <param name="param1">Description of the parameter param1</param>
/// <param name="param2">Description of the parameter param2</param>
/// <param name="param3">Description of the parameter param3</param>
/// <returns>Description of the return value</returns>
function test(param1, param2, param3: string): string;

Für <summary>, es scheint nicht eine Möglichkeit zu sein, Zeilenumbrüche zu ermöglichen. <br /> funktioniert nicht.

Lizenziert unter: CC-BY-SA mit Zuschreibung
Nicht verbunden mit StackOverflow
scroll top