AGB  ·  Datenschutz  ·  Impressum  







Anmelden
Nützliche Links
Registrieren
Zurück Delphi-PRAXiS Sprachen und Entwicklungsumgebungen Die Delphi-IDE Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

Ein Thema von rdeutsch · begonnen am 6. Nov 2014 · letzter Beitrag vom 10. Nov 2014
Antwort Antwort
rdeutsch

Registriert seit: 24. Mär 2006
42 Beiträge
 
#1

Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

  Alt 6. Nov 2014, 08:12
Guten Tag

Gibt es eine Möglichkeit selbst definierten Typen, Konstanten, Variablen, Proceduren etc. Information wie z.B. deren Zweck, Verwendung usw. zu hinterlegen?

In Java/Eclipse kann man einen Typ detailliert beschreiben. Diese Info erscheint dann auch als Hintmessage im Codeeditor, wenn man mit der Maus etwas länger über dem Variablenbezeichner verbleibt.

Gruss Robert
  Mit Zitat antworten Zitat
Benutzerbild von Bernhard Geyer
Bernhard Geyer

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

AW: Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

  Alt 6. Nov 2014, 08:28
Das Tool nennt sich Delphi-IDE und man muss nur den Kommentar passend hinterlegen: http://docwiki.embarcadero.com/RADSt...n/Help_Insight
Windows Vista - Eine neue Erfahrung in Fehlern.
  Mit Zitat antworten Zitat
rdeutsch

Registriert seit: 24. Mär 2006
42 Beiträge
 
#3

AW: Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

  Alt 6. Nov 2014, 09:07
Hallo Bernhard

Danke für deinen Tipp. Die XML Documentation Comments sind mir bekannt, aber diese Art von Kommentaren bläst den Quellcode auf und macht ihn nicht wirklich lesbarer. Der von der Help Insight angezeigte Kommentar ist genau das was ich suche, aber schön wäre es, wenn es dazu ein Tool geben würde, dass die Kommentare auslagert - separate Datei oder so. Somit wäre m.M. der Quellcode auch schlanker und besser lesbar.

Hmm, mal sehen. Vielleicht wäre dies eine Alternative: http://www.devjetsoftware.com/produc...ation-insight/

Gruss Robert
  Mit Zitat antworten Zitat
Benutzerbild von BUG
BUG

Registriert seit: 4. Dez 2003
Ort: Cottbus
2.094 Beiträge
 
#4

AW: Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

  Alt 6. Nov 2014, 10:02
Damit bleiben die XML-Kommentare afaik auch im Code (bloß in Regions versteckt) ... aber WYSIWYG ist für XML-Geraffel schon nicht verkehrt
  Mit Zitat antworten Zitat
mquadrat

Registriert seit: 13. Feb 2004
1.113 Beiträge
 
Delphi XE2 Professional
 
#5

AW: Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

  Alt 6. Nov 2014, 10:25
Was bringt mir eine Entwicklerdoku, die der Entwickler nicht sieht weil sie nicht in den Sourcen steht?

Zugegebenermaßen etwas ketzerisch formuliert.
  Mit Zitat antworten Zitat
Benutzerbild von Uwe Raabe
Uwe Raabe

Registriert seit: 20. Jan 2006
Ort: Lübbecke
9.511 Beiträge
 
Delphi 11 Alexandria
 
#6

AW: Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

  Alt 6. Nov 2014, 10:57
Was bringt mir eine Entwicklerdoku, die der Entwickler nicht sieht weil sie nicht in den Sourcen steht?
... bzw. nicht direkt mit seinen Code-Änderungen aktualisieren kann. (Finde ich übrigens gar nicht ketzerisch!)

Das DocInsight ist schon ein geniales Tool für diesen Zweck. Durch die Regions stören die Kommentare auch kaum. Die Bearbeitung erfolgt sowieso im DocInsight-Editor.

Man kann wohl auch die Kommentare in eine separate Datei auslagern, aber dann funktioniert HelpInsight auch nicht mehr und ein großer Vorteil ist wieder hin. Die eingebettete Doku hat auch den Vorteil, daß sie von anderen leicht nutzbar ist, die kein DocInsight haben.
Uwe Raabe
Certified Delphi Master Developer
Embarcadero MVP
Blog: The Art of Delphi Programming
  Mit Zitat antworten Zitat
rdeutsch

Registriert seit: 24. Mär 2006
42 Beiträge
 
#7

AW: Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

  Alt 6. Nov 2014, 11:27
Ha, jetzt ist mir auch klar wieso mir das Tool "Documentation Insight" abging. Seit XE6 wird es nicht mehr mitgeliefert.
  Mit Zitat antworten Zitat
Benutzerbild von himitsu
himitsu

Registriert seit: 11. Okt 2003
Ort: Elbflorenz
39.684 Beiträge
 
Delphi 11 Alexandria
 
#8

AW: Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

  Alt 6. Nov 2014, 12:06
Durch die Regions stören die Kommentare auch kaum.
Seit XE3 (vielleicht auch XE2) erkennt Delphi die ///-Kommentare und stellt dafür ein CodeFolding bereit, auch ohne $Region drum.
So finde ich das aufgeklappt auch nochmal etwas hübscher.

Die Kommentate (zumindestens den Basisteil davon) erkennt das Help-Insight und zeigt es an. Auch ohne installiertes Dokumentation-Insight, nur dann halt nicht alle "Eigenschaften".

In den Code-Templates sind auch immernoch die alten Vorlagen drin, so daß man es notfalls auch manuell schreiben kann, wenn man das XML nicht komplett selber schreiben will.
Garbage Collector ... Delphianer erzeugen keinen Müll, also brauchen sie auch keinen Müllsucher.
Delphi-Tage 2005-2014
  Mit Zitat antworten Zitat
Benutzerbild von Sherlock
Sherlock

Registriert seit: 10. Jan 2006
Ort: Offenbach
3.588 Beiträge
 
Delphi 10.4 Sydney
 
#9

AW: Gibt es ein Tool/Addon um Typen, Variablen etc. zu beschreiben?

  Alt 10. Nov 2014, 07:22
Ist in der Tat schon seit XE2 so.

Sherlock
Geändert von Sherlock (Morgen um 16:78 Uhr) Grund: Weil ich es kann
  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 02:18 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