Dokumentation von Delphi-Code

[meierotto]

Ich beginne mit einer Frage: Was haben fast alle Softwareprojekte gemeinsam? :gruebel: - Die mangelhafte Dokumentation. :coder2:

Ich habe die Aufgabe, mein Softwareprojekt so zu dokumentieren, dass andere Programmierer problemlos alle Schritte nachvollziehen und in die Programmierung einsteigen können. Dazu suche ich ein (wenn möglich kostenloses) Tool, mit welchem ich den Quelltext meines Projektes strukturiert darstellen kann. D.h. ich möchte zu jedem Objekt die Parameter und eine kurze Funktionsbeschreibung in einem übersichtlichen Dokument ausgeben.
Ich hab mir dazu auch schon Natural Docs angesehen, das ist mir aber etwas zu umständlich. Kennt jemand eine bessere Variante?

Vielen Dank

[sakura]

Du nutzt Delphi 2005, zumindest lt. Deinem Profil. Also nutze doch die XML Quellcode-Dokumentation. Diese Syntax wird inzwischen auch von Delphi vollständig unterstützt.

Damit die XML Dateien erzeugt werden, musst Du in den Projekt-Optionen auf der Compiler-Seite die entsprechende Option setzen. Tools wie NDoc können diese Kommentare verarbeiten und eine HTML7CHM-Hilfe daraus erzeugen.

...:cat:...

[Olli]

Ich benutze Doxygen.

[Bernhard Geyer]

Time2Help basierend auf JavaDoc

[meierotto]

Zitat:

Zitat von sakura

Damit die XML Dateien erzeugt werden, musst Du in den Projekt-Optionen auf der Compiler-Seite die entsprechende Option setzen. Tools wie NDoc können diese Kommentare verarbeiten und eine HTML7CHM-Hilfe daraus erzeugen.

Das klingt sehr gut. Könntest du mir bitte die Verfahrensweise noch etwas genauer beschreiben?

[MathiasSimmack]

Nimm doch den Link von Daniel, der zu Microsoft führt. Da ist alles beschrieben. :)

[sakura]

Es ist leider noch nicht komfortabel, aber die Hürden und Wegelagerer sind hier erklärt: http://bdn.borland.com/article/0,1410,32770,00.html

...:cat:...

[nailor]

falls delphi2005 (welches ich nicht besitze) die gleichen XML-Doku-Dateien erzeugt wie zum Beispiel der Microsoft c# Compiler, dann kann man die mit ndoc sourceforge recht schön formatieren lassen.

[sakura]

Zitat:

Zitat von nailor

falls delphi2005 (welches ich nicht besitze) die gleichen XML-Doku-Dateien erzeugt wie zum Beispiel der Microsoft c# Compiler, dann kann man die mit ndoc sourceforge recht schön formatieren lassen.

Tut es ;-)

...:cat:...

[Christian S.]

Bekommt man es auch irgendwie hin, dass er dieses Meta-Gedönse "TMyClass.@MetaTMyClass" und die Unit-Klasse nicht mit dokumentiert?