 |
 |
 |
 |
 |
|
Antwort
|
|
Registriert seit: 20. Mai 2005 Ort: Cottbus 73 Beiträge Delphi 2005 Professional |
#1
Dokumentation von Delphi-Code
13. Jun 2005, 08:00
Ich beginne mit einer Frage: Was haben fast alle Softwareprojekte gemeinsam?
 - Die mangelhafte Dokumentation.  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 |
Zitat
|
Registriert seit: 10. Jun 2002 Ort: München 11.412 Beiträge Delphi 11 Alexandria |
#2
Re: Dokumentation von Delphi-Code
13. Jun 2005, 08:12
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. ...  ...
Daniel W.
Ich bin nicht zurück, ich tue nur so |
|
Zitat
|
|
(Gast)
n/a Beiträge |
#3
Re: Dokumentation von Delphi-Code
13. Jun 2005, 08:24
Ich benutze
 Doxygen.
|
|
Zitat
|
Registriert seit: 13. Aug 2002 17.172 Beiträge Delphi 10.4 Sydney |
#4
Re: Dokumentation von Delphi-Code
13. Jun 2005, 08:33
Windows Vista - Eine neue Erfahrung in Fehlern.
|
|
Zitat
|
|
Registriert seit: 20. Mai 2005 Ort: Cottbus 73 Beiträge Delphi 2005 Professional |
#5
Re: Dokumentation von Delphi-Code
13. Jun 2005, 08:34
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.
|
|
Zitat
|
|
(Gast)
n/a Beiträge |
#6
Re: Dokumentation von Delphi-Code
13. Jun 2005, 08:36
Nimm doch den Link von Daniel, der zu Microsoft führt. Da ist alles beschrieben.
|
|
Zitat
|
|
Registriert seit: 10. Jun 2002 Ort: München 11.412 Beiträge Delphi 11 Alexandria |
#7
Re: Dokumentation von Delphi-Code
13. Jun 2005, 08:47
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... ...
Daniel W.
Ich bin nicht zurück, ich tue nur so |
|
Zitat
|
Registriert seit: 12. Dez 2002 Ort: Karlsruhe 1.989 Beiträge |
#8
Re: Dokumentation von Delphi-Code
13. Jun 2005, 10:58
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.
Michael N.
http://nailor.devzero.de/code/sharpmath/testing/ --- Tests, Feedback, Anregungen, ... aller Art sehr willkommen!::: don't try so hard - it'll happen for a reason ::: |
|
Zitat
|
|
Registriert seit: 10. Jun 2002 Ort: München 11.412 Beiträge Delphi 11 Alexandria |
#9
Re: Dokumentation von Delphi-Code
13. Jun 2005, 11:10
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. ... ...
Daniel W.
Ich bin nicht zurück, ich tue nur so |
|
Zitat
|
ForumregelnEs 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
|
|
Linear-Darstellung
