Delphi-PRAXiS

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Sonstige Fragen zu Delphi (https://www.delphipraxis.net/19-sonstige-fragen-zu-delphi/)
-   -   Prism Aus Kommentaren eine Hilfe schreiben (Doxygen) ? (https://www.delphipraxis.net/66232-aus-kommentaren-eine-hilfe-schreiben-doxygen.html)

winx 27. Mär 2006 07:17


Aus Kommentaren eine Hilfe schreiben (Doxygen) ?
 
Hallo,

gibt es in Delphi 2006 für .Net schon die Möglichkeit das man seine
Klassen, Variablen und Funktionen mit bestimmten, vorgegebenen
Kommentaren versieht und daraus dann eine Hilfe erstellt wird??

Ich kenne das ganze von Java (Doxygen)...hab schon mit pastodox probiert,
aber das funktioniert auch nich so wirklich.

Gibt es jetzt unter .Net vielleicht schon ne (neue) Möglichkeit?

Danke,
winx

Khabarakh 27. Mär 2006 12:12

Re: Aus Kommentaren eine Hilfe schreiben (Doxygen) ?
 
Aus der vom Compiler generierten XML-Dokumentation kannst du mit XmlDoc ziemliche hübsche Dokus basteln (lassen ;) ).

Elvis 27. Mär 2006 12:15

Re: Aus Kommentaren eine Hilfe schreiben (Doxygen) ?
 
Zitat:

Zitat von Khabarakh
Aus der vom Compiler generierten XML-Dokumentation kannst du mit XmlDoc ziemliche hübsche Dokus basteln (lassen ;) ).

Vorsicht! Das hatte ich auch schonmal jemd empfohlen, der D.Net benutzen muss. Es stellte sich heraus dass D.Net auch hier eigene Wege geht.
Irgendwo auf Code Central sollte es ein perl/python script geben, dass die XML Docs von D.Net in korrekte XML Docs übersetzt, die du dann durch Doku-Generatoren wie nDoc scheuchen kannst...

Muetze1 27. Mär 2006 12:49

Re: Aus Kommentaren eine Hilfe schreiben (Doxygen) ?
 
Oder wenn du Geld für das Programm übrig hast: Doc-O-Matic. Klappt wunderbar direkt auf Delphi Code (u.a.).

Khabarakh 27. Mär 2006 13:18

Re: Aus Kommentaren eine Hilfe schreiben (Doxygen) ?
 
Mönsch Elvis. Du schaffst es immer wieder, mich mit neuen Schauergeschichten über Delphi.Net zu überraschen :stupid: . Wobei ich dieses Mal wirklich gedacht hatte, in keine Gegen-den-Strom-Falle zu tappen, da ich noch dies im Kopf hatte:
Zitat:

Zitat von 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 Bei Google suchenndoc sourceforge recht schön formatieren lassen.

Tut es ;-)

Mit dem Python-Script habe ich ziemlich schlechte Erfahrungen gemacht, allerdings unter Delphi2005.Win32. Wenn das immer noch nicht funktioniert, wäre vielleicht ein Delphi-Xml -> XmlDoc (das Programm heißt natürlich NDoc :oops: ) Converter das Beste. Sollte auch nicht schwer sein, da sich die Formate doch ziemlich ähneln.

winx 30. Mär 2006 08:56

Re: Aus Kommentaren eine Hilfe schreiben (Doxygen) ?
 
Hallo Khabarakh und Elvis,

da ich sowas noch nie gemacht habe, hab ich noch einige Fragen dazu:

- Wo finde ich die vom Compiler generierte XML-Dokumentation?
- Wie muß ich meine Funktionen,Klassen, etc dokumentieren, damit mir der Compiler diese erstellt?
- Wie bring ich den Compiler dazu, dass er mir die erstellt?

Danke für eure Hilfe.

Gruß,
winx

winx 30. Mär 2006 15:20

Re: Aus Kommentaren eine Hilfe schreiben (Doxygen) ?
 
bei nDoc werden immer ALLE Delphi Klassen mit dokumentiert...das dauert dann 30 Minuten, dabei will ich doch nur eine Klasse :-(

und bei Python bekomm ich, wenn ichs laut erkllärung mach, immer den Fehler:

WindowsError: [Errno 3] Das System kann den angegebenen Pfad nicht finden: 'C:\\Programme\\XMLDoc\\xmldoc\\APInorm\\content/*.*'

Das programm liegt im verzeichniss C:\Programme\XMLDoc


Kann mir irgenjemand bei einem der beiden Tools weiterhelfen???

eine genauere Beschreibung findet sich hier:

Fehlermeldung


Alle Zeitangaben in WEZ +1. Es ist jetzt 02:47 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