Software-Dokumentationswerkzeug für Delphi

[greg]

Hallo Comunity,

ich bin neu in der Delphi Gemeinde und sitze nun an meinem Diplomthema.
Hierzu soll ich ein Delphie-Programm entwickeln.

Ich hätte ein Software-Dokumentationswerkzeug für meinen Quellcode(sowie doxygen für C usw.) gibt es da etwas?(Meine Suche im Netzt war nicht erfolgreich)

Und ich hätte ein CVS(Software-System Versionsverwaltung), das kann man wohl dafür nehmen hat da jemand schon Erfahrung gesammeltt?

Danke für euer Hilfe

[Bernhard Geyer]

Zitat:

Zitat von greg

Ich hätte ein Software-Dokumentationswerkzeug für meinen Quellcode(sowie doxygen für C usw.) gibt es da etwas?(Meine Suche im Netzt war nicht erfolgreich)

Doc-O-Matic ist bisher das beste was ich gefunden habe. Diverse OpenSource-Projekte die ich noch getested habe sind entweder überfordert bzw. nicht mehr gepflegt. Und von Doc-O-Matic gibts auch ne Kostenlos-Version.

[Muetze1]

Zitat:

Zitat von greg

Ich hätte ein Software-Dokumentationswerkzeug für meinen Quellcode(sowie doxygen für C usw.) gibt es da etwas?(Meine Suche im Netzt war nicht erfolgreich)

Doxygen hat ein Delphi Plugin, aber die Ausgabe von DoxyGen ist nicht so Delphi geeignet von daher ist es schlecht nutzbar. Ich nutze Doc-O-Matic. Ein Beispiel (HTML) der vielen Ausgabeformate von Doc-O-Matic kannst du dir z.B. zu meiner XMLLib oder der ID3Lib anschauen.

Zitat:

Zitat von greg

Und ich hätte ein CVS(Software-System Versionsverwaltung), das kann man wohl dafür nehmen hat da jemand schon Erfahrung gesammeltt?

Dort gibt es neben SVN als freies System auch z.B. das CS-RCS von ComponentSoftware (für Single Developer umsonst).

/EDIT: Roter Kasten???

[greg]

Danke für euere Hilfe.

Ich habe nun Doc-O-Matic installiert und einen Delphi-Quellcode eingefügt, aber ich weis nicht wie ich nun eine Dokumentation erstelle. Ich die Hilfe gelesen ,aber leider finde ich nichts.
Kann mir jemand erklären was ich machen muss.

[taaktaak]

@greg:
Kurze Zwischenfrage: Interessiere mich auch für dieses Thema. Obwohl ich bedingt der englischen Sprache mächtig bin, würde ich derartige Programme dann doch lieber in deutsch geniessen.
Kann man bei Doc-O-Matic die Sprache auswählen?
Ist auch eine deutsche Hilfe vorhanden?

[greg]

So wie ich das bis jetzt gesehen habe gibt es die Express(kostenlos) Version nicht auf deutsch, eis gibt lediglich eine deutsch Internet Seite.
Aber leider finde ich trotzdem noch nicht wie ich das Tool bedienen muss um für meinen Quellcode eine Doku zu erstellen.

[mkinzler]

Mit dem grafischen Konfigurationstool kannst du eine konfiguration erzeugen, welche du dann mit dem Kommandozeilentool aufrufen kannst.

[greg]

Eigentlich war meine Frage spezieller.

Was muss ich tuen um aus meinen Quellcode eine Doku zubekommen.
Also wo muss ich einen Button betätigen(Die perfekte Einstellung für mich kann ich selber finden).
Leider weis ich nicht wie ich eine Doku generiere.

[mkinzler]

Na einfach diese Konfiguration dem Kommandozeilentool übergeben.

[greg]

Sorry wir drehen uns irgendwie im Kreis. Was meinst du mit Komandozeilentool?

[mkinzler]

domexpress.exe <Pfad zur Konfig>\<Konfigdatei>

[greg]

Jetzt weiß ich was du meinst, aber leider habe ich das noch nie selber gemacht.
Wie geht das?

Soll ich das in die Konsolo so eingeben ("C:\Programme\Doc-O-Matic 6 Express\domexpress.exe"C:\support\neu )?

[Shivan]

Ich find Doc-O-Matic auch gut.

Code:

C:\Programme\Doc-O-Matic 6 Express\domexpress.exe -all c:\pfad\zu\deinem\DokuProjekt.dox-express

Dann wird die gesamte Hilfe generiert, wie du sie im Configfile angegeben hast.

Achja, als Versionierungssystem würde ich an deiner Stelle mal nen Blick auf Subversion werfen.
Und als Client-Tool TortoiseSVN. Aber zu dem Thema gibts ja tausende von Seiten.

[greg]

Danke für die Hilfe, jetzt habe ich endlich den ersten Erfolg. Es wurde mir eine HTML erstellt. Mir hat die korrekte Eingabe gefehlt und der Output-Ordner war Falsch.
Mal sehen ob ich jetzt eine gute Doku zusammen bekomme,weil momentan nur "Documentation Project 1" auf der Site steht(und paar Bildchen)


Ich sehe gerade es geht doch recht gut.
Ich will mich für die schnelle Hilfe bedanken, jetzt kann ich richtig anfangen.

Lösung(so ist meine weis nicht ob die perfekt ist):

1.Einstellen
2.auf C: Ordner Doc-O-Matic_Projekt anlegen
3.domexpressconfig.exe starten
4.In angelegten Ordner speichern
5.Unit1(Source File anlegen und in Ordner kopieren)
6. Auf C: Output Ordner anlegen
7.In Komandozeile eingeben:
"C:\Programme\Doc-O-Matic 6 Express\domexpress.exe" -all c:\Doc-O-Matic_Projekt\Doc-O-Matic_Projekt.dox-express
8.Resultat findet sich in Output Ordner wieder

PS: kann sein das ich was verstellt habe, weil in EigeneDatein->Doc-O-Matic->output vorhanden ist


Hast du noch paar Einstellungstipps für mich?