XE2 Documentation Insight

[hanspeter]

Hallo,
ich probiere das Ding gerade in XE2 prof. aus.
Irgendwie erschließt sich mir der Sinn nicht ganz.
Entweder funktioniert es nicht richtig oder ist arge Crippleware?

Ich kann zwar einzelne Codeteile dokumentieren. Aber nirgendwo sehe ich eine Übersicht mit allen Kommentaren einer Unit oder gar Projekt. Drucken und Dokumentation speichern kann das Ding wohl auch nicht.

Übersehe ich was oder ist das Teil in der express-Variante wirklich unbrauchbar?

Gruß
Peter

[Stevie]

Primäres Ziel von DI ist die Quellcode Dokumentation im XDoc Format. Zusammen mit dem verbesserten Help Insight Template, was du auf der DevJet Seite herunterladen kannst schon eine enorm gute Sache.

Trotzdem fehlen noch einige essenzielle Features, die du schon genannt hast - liegt aber auch daran, dass das Tool noch in den Kinderschuhen steckt. Es wurde eigentlich für den Selbstbedarf geschrieben (der Author wollte eine Möglichkeit haben, sein Delphi Spring Framework zu dokumentieren). Und da wurde dann ein Selbstläufer draus.

Wenn ich mich allerdings richtig erinnere, gibt es schon einige Tools, die aus XDoc eine externe Dokumentation bauen können (glaub, ist sogar in Delphi integriert) - das einzige, was bisher massiv fehlte, ist eine komfortable Weise, diese Dokumentation zu verfassen, ohne den ganzen xml Krams selber zu tippen, oder eventuell vorhandene (oder selbst geschriebene) Templates zu benutzen.

[hanspeter]

Ist zwar schon länger her aber hat einer inzwischen das Ding zum Laufen bekommen?
Ich habe jetzt mal die Demnoversion installiert. Hier ist der gleiche Effekt wie bei der Express-Version.
Ich kann immer nur den unter dem Cursor befindlichen Eintrag in dem Inside_ Editor sehen.
Es wird zwar unter Dukumente undEinstellungen... eine Datei Start.html generiert. Diese enthält aber immer nur ein Eintrag. (Der zuletzt bearbeitete.)
Für einen Tip dankbar.

Mit Gruß
Peter

[mjustin]

Das ist so "as designed", Export ist nicht vorgesehen.

Eine Version 2.0 ist angekündigt, die einen Live Documentation Explorer bietet, mit dem man eine dynamisch erzeugte Übersicht erhält.

Ein Screenshot ist zu sehen unter

http://www.devjet.net/products/docum...nal-is-coming/

[hanspeter]

Also praktisch unbrauchbar?
Man müsste jede einzeln erzeugte start.html Datei manuell weg kopieren und dann zu einer Dokumentation zusammen setzen.
Ist schon etwa eigenartig von Embacadero eine fast unbrauchbare Crippleware als neues Feature von XE2 zu verkaufen.

Peter

[madtom]

Hallo Hanspeter,

das "Ding" ist - wie der Name schon sagt - eine interne Code-Dokumentation. Es wird keine externe Dokumentation erzeugt, diesen Anspruch hat dieses Tool auch nicht. Es werden allerdings standardisierte Tags erzeugt, die dann durch entsprechende andere Tools eingelesen werden und die dann daraus eine Dokumemtation erstellen können. Ich selbst nutze die Version 1.4.2 seit ca. einem Jahr und bin sehr zufrieden.

[Uwe Raabe]

Zitat von hanspeter:

Also praktisch unbrauchbar?
Man müsste jede einzeln erzeugte start.html Datei manuell weg kopieren und dann zu einer Dokumentation zusammen setzen.
Ist schon etwa eigenartig von Embacadero eine fast unbrauchbare Crippleware als neues Feature von XE2 zu verkaufen.

Jetzt bist du aber auf dem völlig falschen Dampfer! Nur weil eine Software nicht für das gedacht ist, für die du sie gerne verwenden möchtest, ist sie noch lange keine Crippleware. Wie schon erwähnt wurde, hat auch die immer noch aktuelle Vollversion in diesem Punkt die gleichen "Einschränkungen", wie die mit XE2 gelieferte Express-Variante. Es ist ja auch nicht unüblich, daß Software mit neuen Versionen an Funktionsumfang zulegt.

Wenn du eine externe Dokumentation aus deinen Sourcen erzeugen willst, empfehle ich Doc-O-Matic. Der Vorteil von DocInsight liegt einfach darin, daß es quasi im laufenden Betrieb CodeInsight unterstützt - die Dokumentation meiner Klassen und ihrer Properties ist direkt über die Programmierhilfe sichtbar und läßt sich auch noch komfortabel editieren. Für das gezahlte Geld kein schlechtes Geschäft - für Doc-O-Matic zahle ich deutlich mehr, bekomme dafür aber auch ganz etwas anderes.

[Codewalker]

Wo genau ist der Unterschied zwischen der Version, die bei XE2 dabei ist und der regulär kaufbaren? Lohnt sich der Kauf auch bei einem evtl. geplanten Wechsel auf XE2?

[madtom]

Da toolseitig einige Änderungen hinzugekommen sind, hole ich das Thema mal aus der Versenkung. So kann jetzt eine externe Dokumentation im HTML-, im CHM- und im HxS-Format direkt aus der IDE (und aus dem Quellcode) erzeugt werden. Diese Funktionalität befindet sich noch im Beta Stadium, ist aber bereits bestellbar und funktioniert nach ersten Versuchen ganz gut.

Der Link: http://www.devjet.net/products/docum...ion-generator/

Beste Grüße