Delphi-PRAXiS

Delphi-PRAXiS (https://www.delphipraxis.net/forum.php)
-   Sonstige Fragen zu Delphi (https://www.delphipraxis.net/19-sonstige-fragen-zu-delphi/)
-   -   Prism Quellcodedokumentierung (https://www.delphipraxis.net/70678-quellcodedokumentierung.html)

XChris 2. Jun 2006 15:33


Quellcodedokumentierung
 
Hallo,

gleich noch eine Frage - zum Thema C# -> Delphi.

Man hat in VS die Möglichkeit, seinen Quellcode zu dokumentieren und diese Dokumentierung der DLL als XML File mitzugeben. Damit ein anderer Programmierer bei der Nutzung via Intellisene damit spielend klar kommt.

Also sieht so aus:

Delphi-Quellcode:
''' <summary>
''' Eine Funktion BlaBla
''' <summary>
void BlaBla()
...
Ruft der andere Programmierer entsprechende Funktion auf, erhält er einen Tooltip. Weitere Tag's ermöglichen Beschreibung von Rückgabetyp und Parametern.

Wie geht dies mit Borland für Delphi.net?
Chris

XChris 3. Jun 2006 08:45

Re: Quellcodedokumentierung
 
Hallo,

gibt es denn wirklich niemanden, der weiß wie man seinen Code sinnvoll Dokumentiert - sodass eine "kleine" Hilfe bei der Nutzung letztendlich erscheint?

Chris

himitsu 3. Jun 2006 10:32

Re: Quellcodedokumentierung
 
Hab bisher jedenfalls sowas noch nicht in Delphi/Pascal gesehn.
Und wenn man sich hier so in den Codes umsieht, dann scheint es das auch wirklich nichts zu geben.

Selber schreibe ich solche Hilfestellungen dann im Interface-Abschnitt als kleine Kommentar direkt über/hinter die Funktion/Prozedur/Konstante..., oder in 'nem InfoBlock unterm Header

Man muß dann halt nur in nötige Datei reinsehen ('s wird also nicht direkt eingelbendet)

Bernhard Geyer 3. Jun 2006 19:36

Re: Quellcodedokumentierung
 
Sollte auch für die .NET-Variante von Delphi gehen: Time2Help


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