AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Thema durchsuchen
Ansicht
Themen-Optionen

Quellcodedokumentierung

Ein Thema von XChris · begonnen am 2. Jun 2006 · letzter Beitrag vom 3. Jun 2006
Antwort Antwort
XChris

Registriert seit: 2. Jun 2006
Ort: Softwaresklave
19 Beiträge
 
#1

Quellcodedokumentierung

  Alt 2. Jun 2006, 16:33
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
  Mit Zitat antworten Zitat
XChris

Registriert seit: 2. Jun 2006
Ort: Softwaresklave
19 Beiträge
 
#2

Re: Quellcodedokumentierung

  Alt 3. Jun 2006, 09:45
Hallo,

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

Chris
  Mit Zitat antworten Zitat
Benutzerbild von himitsu
himitsu

Registriert seit: 11. Okt 2003
Ort: Elbflorenz
44.071 Beiträge
 
Delphi 12 Athens
 
#3

Re: Quellcodedokumentierung

  Alt 3. Jun 2006, 11:32
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)
Neuste Erkenntnis:
Seit Pos einen dritten Parameter hat,
wird PoSex im Delphi viel seltener praktiziert.
  Mit Zitat antworten Zitat
Benutzerbild von Bernhard Geyer
Bernhard Geyer

Registriert seit: 13. Aug 2002
17.197 Beiträge
 
Delphi 10.4 Sydney
 
#4

Re: Quellcodedokumentierung

  Alt 3. Jun 2006, 20:36
Sollte auch für die .NET-Variante von Delphi gehen: Time2Help
Windows Vista - Eine neue Erfahrung in Fehlern.
  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 11:45 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