XMLDoc - Programm für die Weiterverarbeitung der von Delphi erstellten XML Dateien

[jziersch]

Während des Kompilierens kann Delphi XML Dateien für jede kompilierte unit in einem speziellen Ordner erstellen. Dafür muss man lediglich einen Haken in den Projekt Optionen setzen.

Ich wollte diese Dateien zur Erstellung einer API Dokumentation verwenden. Da ich kein geeignetes Programm gefunden haben, habe ich eines - zunächst für eigene Zwecke - geschrieben.

Das Ergebnis könnt ihr hier laden (Alpha - ist noch zeitbeschränkt):
https://www.wpcubed.com/ftp/XMLDocInspector.zip (2.7MB - signierte EXE im ZIP)

Man kann in diesem Programm XML Dateien aus verschiedenen Verzeichnissen in eine Liste laden.
In dieser Liste trifft man dann nochmal die Auswahl welche der Dateien ausgewertet werden sollen und läd sie. Mit "Process" findet die endgültige Auswertung statt.

Im Browser Tab kann man einige der Klassen auswählen und bekommt dann übersichtlich die Eigenschaften und Methode angezeigt. Im Browser tab wird dann blitzschnell in einem WPTools Editor eine kleine Dokumentation erstellt.

Mit /// markierte Beschreibungen werden geladen. In der endgültigen Version werden auch andere Kommentare ausgewertet.

Würdet Ihr eine solche Software einsetzen?

[TiGü]

Ist das nicht das was PasDoc macht?
https://pasdoc.github.io/index

Beispiele:
https://allegro-pas.sourceforge.net/docs/5.2/
https://castle-engine.io/apidoc/html/index.html

[jziersch]

Ja, grundsätzlich schon.

Mein Ansatz wird aber letztendlich dafür verwendet werden um eine Art CMS zu füttern. (Die Software die ich bisher verwendet habe wird schon seit Ewigkeiten nicht mehr weiter entwickelt, daher musste Ersatz her.)

[Uwe Raabe]

Zitat von jziersch:

Da ich kein geeignetes Programm gefunden haben

Da ich die XML-Doku in der IDE mit Hilfe von Documentation Insight Professional mache, nutze ich die darin enthaltene Funktionalität Generate Documentation - meistens um direkt ein Help & Manual Projekt zu erzeugen. Andere unterstützte Formate sind HTML, CHM und HxS.

[jziersch]

Danke für den Tip - Documentation Insight sieht gut aus.
Ich hatte etwas Ähnliches in Verwendung für viele Jahre ("Time2Help" - eine Version 2 davon ist bisher leider nicht rausgekommen). Ich werde prüfen ob das mein Problem löst und performant bei meinen großen Projekten ist.

[himitsu]

Schön beim Documentation Insight ist der Editor im Delphi.
Außerdem erweitert es den Funktionsumfang etwas, inkl. ersetzen des Viewers vom HelpInsight (der Hint über Objekten im Code, welcher aus'm PasDoc generiert wird).

Eine Zeit lang war im Delphi eine Lite-Version direkt integriert (leider nicht mehr) ... so hat man nun standardmä0ig nur noch die CodeTemplates für die Kommentare.

[Harry Stahl]

Wenn es nur um die eigene Dokumentation geht, dann kann evtl. schon die (kostenlose) Möglichkeit reichen, eine Dokumentation aus den XML-Doc Kommentaren zu erstellen, mit meinem Pascal-Editor (https://youtu.be/G_rmGixTlso?si=6Qwyu5enRLFOGIrZ)

Für User-Produkt Dokumentationen ist es aber wohl eher weniger geeignet.

In Delphi selber nutze ich für die Erzeugung der XML-Kommentare nicht das manuelle eintippen der Signalwörter (z.B. Summary + Tab - ist mir zu umständlich), sondern verwende da meinen Pascal-Input helper, das geht eigentlich recht gut: https://youtu.be/j3NE-9-5avA?si=fgYwhmQocewr19kE

[jziersch]

Mein Projekt hat etwas Fortschritte gemacht. Dabei kam auch ordentlich WPTools 9.3 zum Einsatz

Im Gegensatz zu den bekannten Lösungen hat es zwei Besonderheiten:
1) Es liest Kommentare aus den Quellcodes die einfach mit {:: markiert wurden. HTML Tags und /// sind also nicht unbedingt erforderlich.
2) Die erzeugten Seiten werden zwar dynamisch Skript gesteuert erzeugt, es können aber dennoch Bereiche editiert werden, sofern das nötig ist. Man kann also Beschreibungen nachpflegen, ohne dass dafür der Pascal Quellcode geändert werden muss. Diese Änderungen bleiben erhalten, auch wenn man den Code neu einliest oder ein anderes Ausgabeskript verwendet.

Anbei ein Screenshot von einer erzeugten HTML Datei.
Ich bringe zu den Forentagen morgen (14.10.23) einen Computer mit und zeige gerne das Konzept