AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren

Delphi Quellcode Dokumentation

Ein Thema von Ajintaro · begonnen am 8. Jan 2015 · letzter Beitrag vom 11. Jan 2015
Antwort Antwort
Benutzerbild von Ajintaro
Ajintaro

Registriert seit: 20. Okt 2004
Ort: Sankt Augustin
138 Beiträge
 
Delphi XE6 Starter
 
#1

Delphi Quellcode Dokumentation

  Alt 8. Jan 2015, 14:16
Hi DP!

Wie dokumentiert ihr eure Quellcodes ? Nutzt ihr dafür tools wie Documentation Insight o.ä. ? Gibt es keine Delphi (XE6) keine eigene Dokumentationsfunktion ?

Gruß,

Ajin
Jaimy
DAoC 2.0 -> Camelot Unchained !
  Mit Zitat antworten Zitat
Benutzerbild von Bernhard Geyer
Bernhard Geyer
Online

Registriert seit: 13. Aug 2002
17.027 Beiträge
 
Delphi 10.4 Sydney
 
#2

AW: Delphi Quellcode Dokumentation

  Alt 8. Jan 2015, 14:26
Delphi hat da auch schon was eingebaut: http://docwiki.embarcadero.com/RADSt...ation_Comments
Selbst verwenden wir noch den Javadoc-Ansatz: http://en.wikipedia.org/wiki/Javadoc
Windows Vista - Eine neue Erfahrung in Fehlern.
  Mit Zitat antworten Zitat
Benutzerbild von himitsu
himitsu

Registriert seit: 11. Okt 2003
Ort: Elbflorenz
39.410 Beiträge
 
Delphi 11 Alexandria
 
#3

AW: Delphi Quellcode Dokumentation

  Alt 8. Jan 2015, 14:36
Das Help-Insight kann einige Basisinfos vom Docu-Insight/XMLDoc anzeigen und das bereits seit Delphi 2005. (vermutlich ... jedenfalls nur in der neuen IDE)
In den CodeTemplates liegen dafür auch einige Vorlagen, die du immernoch verwenden kannst ... nur halt nicht so "komfortabel", wie mit dem Documentation Insight.

Ich verwende immernoch das Documentation Insight, denn ich nurtze den Code selber als Dokumentation (die Funktions- und Klassenheader) und scheibe zusätzlich auch die Beschreibung via Docu-Insight dort rein, denn es ist unheimlich praktisch, da die das Help-Insight das beim Code-Schreiben mit anzeigt.
Garbage Collector ... Delphianer erzeugen keinen Müll, also brauchen sie auch keinen Müllsucher.
Delphi-Tage 2005-2014
  Mit Zitat antworten Zitat
Der schöne Günther

Registriert seit: 6. Mär 2013
5.888 Beiträge
 
Delphi 10 Seattle Enterprise
 
#4

AW: Delphi Quellcode Dokumentation

  Alt 8. Jan 2015, 15:11
Documentation Insight war in einer Express-Vatiante dabei, seit XE6 nicht mehr. Musst du jetzt zusätzlich kaufen.
  Mit Zitat antworten Zitat
Benutzerbild von Stevie
Stevie
Online

Registriert seit: 12. Aug 2003
Ort: Soest
3.898 Beiträge
 
Delphi 10.1 Berlin Enterprise
 
#5

AW: Delphi Quellcode Dokumentation

  Alt 8. Jan 2015, 17:26
Dokumentation? Pff, son Mumpitz, braucht man nich!

Ok, Spaß beseite, wenn ich mal dokumentiere, dann mit Documentation Insight.
Ist um einiges einfacher, als in den xmldoc tags händisch rumzuhampeln.

P.S. Evtl gibts demnächst bei Spring4D mal nen DocInsight abzustauben, muss mir nur noch was fieses als Aufgabe ausdenken
Stefan
“Simplicity, carried to the extreme, becomes elegance.” Jon Franklin

Delphi Sorcery - DSharp - Spring4D - TestInsight

Geändert von Stevie ( 8. Jan 2015 um 17:29 Uhr)
  Mit Zitat antworten Zitat
Dejan Vu
(Gast)

n/a Beiträge
 
#6

AW: Delphi Quellcode Dokumentation

  Alt 11. Jan 2015, 08:04
Im Grunde genommen ist das aber auch nichts anderes als das mit den XML-Tags. Der eine tippt lieber, der andere klickt lieber (auf das DocInsight-Fenster).

Wichtig ist, *das* man es macht, und vor allen Dingen, *was* genau (mindestens) drin stehen sollte.

Schwierig wird es -generell- bei Kommentaren wie:
Delphi-Quellcode:
/// <summary>
/// Removes all unsolved references
/// </summary>
Procedure TMyClass.RemoveAllUnresolvedReferences;
Begin
End;
Aber bevor man in den ToolTips gar nichts sieht und sich fragt "Was macht die denn nun genau, die Methode", schreibt man lieber solch redundantes Zeugs rein. Aber vielleicht kann man mit 1-2 Sätzen noch Details beschreiben, oder ein Beispiel geben. Dann sieht das nicht ganz so bescheuert aus.

Wohlgemerkt: Nur bei öffentlichen Methoden. Private Methoden sind ja eh selbsterklärend.
  Mit Zitat antworten Zitat
Benutzerbild von himitsu
himitsu

Registriert seit: 11. Okt 2003
Ort: Elbflorenz
39.410 Beiträge
 
Delphi 11 Alexandria
 
#7

AW: Delphi Quellcode Dokumentation

  Alt 11. Jan 2015, 08:39
Die Gratisversion, welche mal im Delphi dabei war, erlaubte es eh nur Public-Zeugs zu dokumentieren.
Private-Methoden und Kommentare in Implementation waren verboten und zusätzlich auch praktisch jede praktische Formatierung oder zusätzliche HTML-Tags (Bilder, Listen usw.) in den Kommentaren. (Der Editor bot es nicht an, aber wenn es in den Kommentaren schon drin stand, dann wurde es dennoch angezeigt)
Garbage Collector ... Delphianer erzeugen keinen Müll, also brauchen sie auch keinen Müllsucher.
Delphi-Tage 2005-2014
  Mit Zitat antworten Zitat
Themen-Optionen Thema durchsuchen
Thema durchsuchen:

Erweiterte Suche
Ansicht

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 13:04 Uhr.
Powered by vBulletin® Copyright ©2000 - 2022, Jelsoft Enterprises Ltd.
LinkBacks Enabled by vBSEO © 2011, Crawlability, Inc.
Delphi-PRAXiS (c) 2002 - 2021 by Daniel R. Wolf