Einzelnen Beitrag anzeigen

markusl

Registriert seit: 25. Apr 2006
Ort: Rotkreuz
21 Beiträge
 
Delphi 5 Enterprise
 
#3

Re: Together - Dokumentation generieren - Kommentare

  Alt 23. Nov 2006, 12:13
Hallo hirnstroem,

ich habe vor einer Weile die Quelltext-Dokumentationsfunktion von
dem im BDS2006 integrierten Together evaluiert und für nicht ausreichend befunden.

Die Syntax lehnt sich an den Bei Google suchenXMLDOC-Standard an, unterstützt allerdings
nicht alle dort definierten Tags und verhält sich etwas eigentümlich.

Sofern Du es dennoch ausprobieren möchtest, kannst du im Interface-Abschnitt Deiner
Klassen unmittelbar vor einer Methode/Property folgenden Kommentar setzen:

Delphi-Quellcode:
/// <author>Test Tester</author>
/// <remarks>This is a test function
/// description 2
/// description 3
/// description 4</remarks>
function xyz : String;
....

Ich benutze im Moment JADD und bin sehr zufrieden damit.
Es ist sehr leistungsfähig, benutzt Javadoc-Syntax, kann direkt PDFs generieren und ist vielfältig konfigurierbar.


Gruss,

Markus
  Mit Zitat antworten Zitat