Delphi-PRAXiS

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Sonstige Fragen zu Delphi (https://www.delphipraxis.net/19-sonstige-fragen-zu-delphi/)
-   -   Sourcecode-Dokumentation im Stil von Sandcastle/Document! X für Delphi? (https://www.delphipraxis.net/159682-sourcecode-dokumentation-im-stil-von-sandcastle-document-x-fuer-delphi.html)

alaenge 7. Apr 2011 20:43

Sourcecode-Dokumentation im Stil von Sandcastle/Document! X für Delphi?
 
Hallo,

ich suche ein Tool, das eine Sourcecode-Dokumentation aus XML-Kommentaren im Delphi-Code erstellt und in etwa die Funktionalität von Sandcastle oder Document! X (beides für .NET) hat. Das Ergebnis sollte nicht wie JavaDoc aussehen, sondern sich am MSDN-Stil orientieren und das Tool sollte den Dokumentationsumfang konfigurierbar machen. Ausgabe als CHM oder PDF wären toll ;) Document! X bietet außerdem die Möglichkeit, eigene Contenttypen zu erzeugen - wäre auch nicht schlecht.
Hat jemand einen Tipp für mich?

Grüße
Anja

s.h.a.r.k 7. Apr 2011 20:46

AW: Sourcecode-Dokumentation im Stil von Sandcastle/Document! X für Delphi?
 
Bringt dich das hier evtl. weiter? Schau dir auch den ersten Link im Text an.

Namenloser 7. Apr 2011 20:48

AW: Sourcecode-Dokumentation im Stil von Sandcastle/Document! X für Delphi?
 
Ich kenne die von dir genannten Tools kenne ich nicht, aber PasDoc könnte vielleicht ganz interessant für dich sein. Wenn du ein Beispiel suchst, kannst du dir die Dokumentation von Andorra 2D anschauen.

Selbst habe ich damit noch nicht gearbeitet.

himitsu 7. Apr 2011 21:00

AW: Sourcecode-Dokumentation im Stil von Sandcastle/Document! X für Delphi?
 
PasDoc wird von aktuellen Delphis zum Teil schon unterstützt und werden mit /// eingeleitet.
So gibt es da auch einige Codevorlagen, welche einem ein bissl helfen können. Nur mit dem Anzeigen dieser Infos über Code Insight hapert es noch etwas :cry: und ein Tool, um diese Infos zu extrahieren (und z.B. eine HTML-Doku zu erstellen) ist auch nicht direkt in der IDE integriert.



PS: PasDoc, PHPDoc und Co. stammen von http://de.wikipedia.org/wiki/JavaDoc ab

s.h.a.r.k 7. Apr 2011 21:08

AW: Sourcecode-Dokumentation im Stil von Sandcastle/Document! X für Delphi?
 
Es gab doch auch mal einen Thread, in dem so eine Doku-Software vorgestellt wurde. War das aber die, die NamenLozer aufgezeigt hat? Ich finde den Thread nämlich gerade nicht.

alaenge 8. Apr 2011 15:03

AW: Sourcecode-Dokumentation im Stil von Sandcastle/Document! X für Delphi?
 
Hallo,

habe ich mir alles einmal angeschaut, paßt aber nicht ganz.
Es sollten XML-Kommentare verarbeitet werden, kein JavaDoc und auch die Ausgabe sollte nicht nach JavaDoc aussehen (-> Augenkrebs).
Delphi 2010 bietet zwar eine Modellingunterstützung mit Dokumentationsgenerierung, aber das Ergebnis ist noch recht unschön.
Es paßt zwar nicht ganz hierher ;) aber wen es interessiert:
Sandcastle
Sandcastle Help File Builder
Document! X
Die Ergebnisse haben dann das typische MSDN-Design und -Layout:
Example Output

vG
Anja

igel457 8. Apr 2011 15:44

AW: Sourcecode-Dokumentation im Stil von Sandcastle/Document! X für Delphi?
 
Zitat:

Zitat von s.h.a.r.k (Beitrag 1093767)
Es gab doch auch mal einen Thread, in dem so eine Doku-Software vorgestellt wurde. War das aber die, die NamenLozer aufgezeigt hat? Ich finde den Thread nämlich gerade nicht.

Meinst du den hier? http://www.delphipraxis.net/152894-a...onssystem.html

Ich habe da ein System für PasDoc geschrieben, der Download findet sich hier: http://sourceforge.net/projects/ando...les/pasxmldoc/ eine Dokumentation in Form einer Readme ist auch in dem Paket enthalten. Allerdings habe ich das Ganze nur unter Linux getestet.


Alle Zeitangaben in WEZ +1. Es ist jetzt 05:27 Uhr.

Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz