AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Sprachen und Entwicklungsumgebungen Sonstige Fragen zu Delphi Delphi Together - Dokumentation generieren - Kommentare
Thema durchsuchen
Ansicht
Themen-Optionen

Together - Dokumentation generieren - Kommentare

Ein Thema von hirnstroem · begonnen am 6. Nov 2006 · letzter Beitrag vom 11. Sep 2008
Antwort Antwort
hirnstroem

Registriert seit: 21. Sep 2005
297 Beiträge
 
Delphi 2006 Professional
 
#1

Together - Dokumentation generieren - Kommentare

  Alt 6. Nov 2006, 08:56
'loha Folks,

ich würde gerne eine Together-Dokumentation generieren, bei welcher all meine vielen Kommentare im Quellcode mitberücksichtigt werden. Leider finde ich nirgens Hinweise, wie denn die Annotationen zu formatieren sind, damit sie berücksichtigt werden.

Weiss zufälligerweise jemand, wie diese Kommentare auszusehen haben, oder zumindest wo nachgelesen werden kann, wie sie auszusehen haben?

Grüsse
hirnstroem
inde deus abest
  Mit Zitat antworten Zitat
hirnstroem

Registriert seit: 21. Sep 2005
297 Beiträge
 
Delphi 2006 Professional
 
#2

Re: Together - Dokumentation generieren - Kommentare

  Alt 23. Nov 2006, 09:40
Benutzt diese "Dokumentation generieren"-Funktion denn überhaupt jemand?
inde deus abest
  Mit Zitat antworten Zitat
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
hirnstroem

Registriert seit: 21. Sep 2005
297 Beiträge
 
Delphi 2006 Professional
 
#4

Re: Together - Dokumentation generieren - Kommentare

  Alt 23. Nov 2006, 14:04
Hallo Markus, vielen Dank für die Antwort.

Ich habe bereits versucht solche Konstrukte wie das folgende zu bilden, jedoch mit minder grossem Erfolg, sprich, in der Dokumentation wurden dies Kommentare nicht angezeigt.

Delphi-Quellcode:
/// <author>ava</author> // <- solche sachen sollten ja eigentlich greifen
/// <remarks>inde deus abest</remarks>
procedure TfrmLogin.btnloginClick(Sender: TObject);
var
  Password, DBPassword, Username, DBUsername: String;
  Q: TADOQuery;
begin
  // Usernae and Password are transformed into lower case characters
  // to avoid Caps Lock problems
Die Delphi-Hilfe bringt einen da auch nicht wirklich weiter.

Andere Dokumentationsgeneratoren werden mit dem vermerk angeboten, alles ab Delphi 2005 nicht mehr so wirklich oder noch nicht vollständig zu unterstützen.

Mal abwarten.
inde deus abest
  Mit Zitat antworten Zitat
markusl

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

Re: Together - Dokumentation generieren - Kommentare

  Alt 23. Nov 2006, 14:11
Du musst deine Kommentare über der Deklaration stehen haben, nicht bei der Definition der Methoden.
Dann sollte es eigentlich funktionieren.

Markus
  Mit Zitat antworten Zitat
Benutzerbild von Motzi
Motzi

Registriert seit: 6. Aug 2002
Ort: Wien
598 Beiträge
 
Delphi XE2 Professional
 
#6

Re: Together - Dokumentation generieren - Kommentare

  Alt 29. Nov 2006, 11:45
Ich bin heute auf dasselbe Problem gestoßen.
Ich füge im Interface-Abschnitt diverse Kommentare zu Interfaces bzw Methoden hinzu, diese tauchen in der generierten Dokumentation aber nirgends auf. Weiß jemand woran das liegen kann?

Gruß, Motzi
Manuel Pöter
  Mit Zitat antworten Zitat
markusl

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

Re: Together - Dokumentation generieren - Kommentare

  Alt 30. Nov 2006, 09:33
@Motzi: Poste doch mal einen Beispiel-Kommentar, der nicht funktioniert.

Ich sehe grade dass Du Delphi 2005 einsetzt. Eventuell funktioniert es dort nicht so,
kann es hier grade nicht testen.

Gruss,

Markus
  Mit Zitat antworten Zitat
HeinzJ

Registriert seit: 17. Aug 2007
Ort: Bremen
84 Beiträge
 
Delphi 2007 Architect
 
#8

Re: Together - Dokumentation generieren - Kommentare

  Alt 11. Sep 2008, 10:43
In Delphi 2007 scheint es das gleiche Problem mit den "/// ..." Komentaren zu geben.
  Mit Zitat antworten Zitat
Antwort Antwort


Forumregeln

Es 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

Gehe zu:

Impressum · AGB · Datenschutz · Nach oben
Alle Zeitangaben in WEZ +1. Es ist jetzt 10:52 Uhr.
Powered by vBulletin® Copyright ©2000 - 2024, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2023 by Daniel R. Wolf, 2024 by Thomas Breitkreuz