AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Sprachen und Entwicklungsumgebungen Sonstige Fragen zu Delphi Sourcecode-Dokumentation im Stil von Sandcastle/Document! X für Delphi?

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

Ein Thema von alaenge · begonnen am 7. Apr 2011 · letzter Beitrag vom 8. Apr 2011
Antwort Antwort
alaenge

Registriert seit: 7. Apr 2011
5 Beiträge
 
#1

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

  Alt 7. Apr 2011, 20:43
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
  Mit Zitat antworten Zitat
Benutzerbild von s.h.a.r.k
s.h.a.r.k

Registriert seit: 26. Mai 2004
3.159 Beiträge
 
#2

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

  Alt 7. Apr 2011, 20:46
Bringt dich das hier evtl. weiter? Schau dir auch den ersten Link im Text an.
»Remember, the future maintainer is the person you should be writing code for, not the compiler.« (Nick Hodges)
  Mit Zitat antworten Zitat
Namenloser

Registriert seit: 7. Jun 2006
Ort: Karlsruhe
3.724 Beiträge
 
FreePascal / Lazarus
 
#3

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

  Alt 7. Apr 2011, 20:48
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.
  Mit Zitat antworten Zitat
Benutzerbild von himitsu
himitsu

Registriert seit: 11. Okt 2003
Ort: Elbflorenz
34.931 Beiträge
 
Delphi 10.2 Tokyo Professional
 
#4

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

  Alt 7. Apr 2011, 21:00
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 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
Garbage Collector ... Delphianer erzeugen keinen Müll, also brauchen sie auch keinen Müllsucher.
Delphi-Tage 2005-2014
  Mit Zitat antworten Zitat
Benutzerbild von s.h.a.r.k
s.h.a.r.k

Registriert seit: 26. Mai 2004
3.159 Beiträge
 
#5

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

  Alt 7. Apr 2011, 21:08
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.
»Remember, the future maintainer is the person you should be writing code for, not the compiler.« (Nick Hodges)
  Mit Zitat antworten Zitat
alaenge

Registriert seit: 7. Apr 2011
5 Beiträge
 
#6

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

  Alt 8. Apr 2011, 15:03
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
  Mit Zitat antworten Zitat
Benutzerbild von igel457
igel457

Registriert seit: 31. Aug 2005
1.622 Beiträge
 
FreePascal / Lazarus
 
#7

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

  Alt 8. Apr 2011, 15:44
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.
Andreas
"Sollen sich auch alle schämen, die gedankenlos sich der Wunder der Wissenschaft und Technik bedienen, und nicht mehr davon geistig erfasst haben als die Kuh von der Botanik der Pflanzen, die sie mit Wohlbehagen frisst." - Albert Einstein
  Mit Zitat antworten Zitat
Themen-Optionen Thema durchsuchen
Thema durchsuchen:

Erweiterte Suche
Ansicht

Forumregeln

Es ist dir nicht erlaubt, neue Themen zu verfassen.
Es ist dir nicht erlaubt, auf Beiträge zu antworten.
Es ist dir nicht erlaubt, Anhänge hochzuladen.
Es ist dir nicht erlaubt, deine Beiträge zu bearbeiten.

BB-Code ist an.
Smileys sind an.
[IMG] Code ist an.
HTML-Code ist aus.
Trackbacks are an
Pingbacks are an
Refbacks are aus

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 07:21 Uhr.
Powered by vBulletin® Copyright ©2000 - 2019, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2019 by Daniel R. Wolf