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

[rdeutsch]

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

[Bernhard Geyer]

Das Tool nennt sich Delphi-IDE und man muss nur den Kommentar passend hinterlegen: http://docwiki.embarcadero.com/RADSt...n/Help_Insight

[rdeutsch]

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

[BUG]

Zitat:

Zitat von rdeutsch (Beitrag 1278878)

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

Damit bleiben die XML-Kommentare afaik auch im Code (bloß in Regions versteckt) ... aber WYSIWYG ist für XML-Geraffel schon nicht verkehrt :mrgreen:

[mquadrat]

Was bringt mir eine Entwicklerdoku, die der Entwickler nicht sieht weil sie nicht in den Sourcen steht?

Zugegebenermaßen etwas ketzerisch formuliert. ;-)

[Uwe Raabe]

Zitat:

Zitat von mquadrat (Beitrag 1278890)

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.

[rdeutsch]

Ha, jetzt ist mir auch klar wieso mir das Tool "Documentation Insight" abging. Seit XE6 wird es nicht mehr mitgeliefert. :roll:

[himitsu]

Zitat:

Zitat von Uwe Raabe (Beitrag 1278898)

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.

[Sherlock]

Ist in der Tat schon seit XE2 so.

Sherlock