source code dokumentation

[bernhard_LA]

a) ist das Thema Source Code Dokumentation mit javaDoc eigentlich gestorben ? siehe http://dephicodetodoc.sourceforge.net/


b) geht der Trend jetzt zu XML Doku ? (nicht nur für C#, VB, C++)

c) gibt es einen Umsetzer für meine Doku in JAVA DOC nach XML als freies Tool ?

[mjustin]

Eventuell ist ohne große Änderungen doxygen einsetzbar, es unterstützt mehrere Dokumentationsstile.

Um es mit Delphi verwenden zu können, wird als "Filter" pas2dox dazwischengeschaltet, das wird in der doxygen Konfiguration eingetragen. pas2dox ist auf Sourceforge erhältlich.

Beispielausgabe HTML: Open Component Test Framework (OpenCTF) Dokumentation

[danielmagin]

in delphi xe2 gibt es ha Dokumentation Insight

ein sehr gutes Tool für Dokumentation für xml

nach deinem Profil hast du ja xe2 entp. schon mal angeschaut

die grosse Variante und auch für "ältere" Delphi (ab 7 und höher) gibt's hier

Link: documentation-insight/

grüsse

daniel m

:-D

[Codewalker]

Ich nutze das von Daniel beschriebene Documentation Insight (die gekaufte Version, nicht die bei Delphi XE2). Damit habe ich jetzt in einem Package alles schön dokumentiert, bekomme die Hints schön angezeigt und kann im neuen "Documentation Explorer" mir die Doku auch schön ansehen. ABER: Wie kriege ich die Doku in eine externe Hilfedatei?

[Panthrax]

Zitat:

Zitat von Codewalker (Beitrag 1158454)

die gekaufte Version, nicht die bei Delphi XE2

Du nutzt doch XE2 (Profilangabe)? Warum hast Du es gekauft? Was ist der Unterschied?

[mkinzler]

Bei der Version in XE2 handelt es sich um die abgespeckte Express-Ausgabe von DI

[Codewalker]

Zitat:

Zitat von Panthrax (Beitrag 1158459)

Zitat:

Zitat von Codewalker (Beitrag 1158454)

die gekaufte Version, nicht die bei Delphi XE2

Du nutzt doch XE2 (Profilangabe)? Warum hast Du es gekauft? Was ist der Unterschied?

Außerdem habe ich es gekauft, bevor ich Delphi XE2 gekauft habe

[Panthrax]

Danke! -- Was der Unterschied ist, konnte ich aber auch auf den Seiten von DevJet nicht herausfinden. Das einzige Angebot: 99 Euro pro Entwickler? In einem Blog-Beitrag vom 1.9.2011 wird aber auch von einer Professional- und einer Enterprise-Version gesprochen.

Also, was genau sind die Unterschiede?

[mjustin]

Zitat:

Zitat von Codewalker (Beitrag 1158454)

Ich nutze das von Daniel beschriebene Documentation Insight (die gekaufte Version, nicht die bei Delphi XE2). Damit habe ich jetzt in einem Package alles schön dokumentiert, bekomme die Hints schön angezeigt und kann im neuen "Documentation Explorer" mir die Doku auch schön ansehen. ABER: Wie kriege ich die Doku in eine externe Hilfedatei?

Documentation Insight ist eine IDE Erweiterung, und ein komfortabler Hilfeeditor, aber es enthält keinen Generator für Hilfedateien (auch nicht in der Kaufversion).

[Codewalker]

Zitat:

Zitat von mjustin (Beitrag 1158472)

Zitat:

Zitat von Codewalker (Beitrag 1158454)

Ich nutze das von Daniel beschriebene Documentation Insight (die gekaufte Version, nicht die bei Delphi XE2). Damit habe ich jetzt in einem Package alles schön dokumentiert, bekomme die Hints schön angezeigt und kann im neuen "Documentation Explorer" mir die Doku auch schön ansehen. ABER: Wie kriege ich die Doku in eine externe Hilfedatei?

Documentation Insight ist eine IDE Erweiterung, und ein komfortabler Hilfeeditor, aber es enthält keinen Generator für Hilfedateien (auch nicht in der Kaufversion).

Ich weiß. Aber die Dokumentation die man damit pflegt kann man ja per Delphi-Compiler als xml-Datei ausgeben (s. andere Threads). Nur wie komme ich damit weiter. Der naive Versuch die direkt in den Sandcastle Help File Builder zu füttern klappt schon mal gar nicht.