Documentation insight vs Doc-O-Matic

[pHL]

Hallo Leute.

Da ich mich in nächster Zeit gerne für ein Source-Dokumentationstool entscheiden möchte hätte ich noch gerne ein paar Meinungen von euch.

In meiner engeren Auswahl sind nun "Documentation Insight (Enterprise)" und "Doc-O-Matic (Professional)". Einmal abgesehen vom Preis habe ich auf den ersten Blick folgende Unterschiede erkennen können.

Documentation Insight:

• + Integration in die IDE
• - Dokumentation nur im Source möglich

Doc-O-Matic:

• - Keine Integration in die IDE
• + Dokumentation kann in eigene Dateien ausgelagert werden

Hat jemand von euch Erfahrungswerte mit einem der beiden Tools bzw. kennt ihr Quellen wo die Unterschiede aufgezeigt werden?
Für Doc-O-Matic habe ich bis jetzt nur sehr wenig gefunden (leider auch keine Anleitung).

Danke im Vorraus
pHL

[himitsu]

Zitat von pHL:

Documentation Insight:

• - Dokumentation nur im Source möglich

Man überlegt schon (seit mindestens 2 Jahren), wie und ob die Dokumentationen, innerhalb der Units oder auch ganz da raus, verschoben werden können.

Aber ob/wann die das mal schaffen .........




Nja, zumindestens ist die Hilfe innerhalb der IDE nicht schlecht.
Du kannst Funktionen dokumentieren und bekommst beim Programmieren diese Infos direkt angezeigt.

[pHL]

Zitat von himitsu:

Nja, zumindestens ist die Hilfe innerhalb der IDE nicht schlecht.
Du kannst Funktionen dokumentieren und bekommst beim Programmieren diese Infos direkt angezeigt.

Das mit der direkten Info beim Programmieren ist natürlich sehr toll. Aber funktiniert das nicht mit allen XML-Kommentaren (welche man ja auch mit doc-o-matic) erstellen könnte?

[himitsu]

Aber die müssten dann wohl auch mit an der selben Stelle in der PAS liegen.
Und wenn man schon beim Programmieren ist, dann kann man von da aus diese Kommentare auch gleich bearbeiten.

Ich finde diese Kommentare mitten im Quellcode zwar immernoch störend, wenn man in dem Code rumstöbert, aber zumindestens wird es etwas besser, wenn man diese Kommentare in Regions einschließt und zusammenfaltet.


In wie weit das aber mit der Erzeugung einer externen Hilfe aussieht, kann ich allerdings nicht beurteilen.

[pHL]

Ohne den Regions wäre das ganze sowieso nicht tragbar

Zitat von himitsu:

In wie weit das aber mit der Erzeugung einer externen Hilfe aussieht, kann ich allerdings nicht beurteilen.

Danke für die Info. Das muss ich unbedingt noch testen. Ich kann mir aber nicht vorstellen dass es dann nicht mehr funktionieren sollte.

Aber so wie es aussieht sind die zwei Punkte in meinem Eingangspost wirklich der Hauptunterschied (von dem Preis abgesehen).

[Uwe Raabe]

Es läuft gerade eine offene Beta für die nächste Version von Documentation Insight. Wenn du bei Google+ bist, kannst du das über die DevJet Software Community verfolgen. Für einen Überblick zu neuen Features gibt es diesen Blog-Eintrag: http://www.devjetsoftware.com/produc...ion-insight-3/

Es ist aber in jedem Fall so, daß die integrierten Hints nur mit Doku im Quelltext gehen.

Ich habe übrigens beide Tools hier, arbeite aber für Quelltextdoku nur noch mit DI - das ist wesentlich bequemer.

[Der schöne Günther]

Die IDE bietet doch standardmäßig an, die Doku-Blöcke zusammenzufalten, auch ohne $REGION . Und wenn die einen grundsätzlich stören, gibt es auch Rechtsklick doch auch einen Punkt "Alle Doku-Blöcke zusammenfalten".

So finde ich stört das eigentlich nicht. Was mir nur fehlt ist, zumindest bei DI, eine tiefere Integration in die IDE, so dass das Refactoring auch die Doku entsprechend aktualisiert. Wenn man mal einen Member umbenennt, bekommt die Doku das nicht mit...

[pHL]

Danke für die Antworten. Dann wird es wohl DI werden.

[Uwe Raabe]

Zitat von Der schöne Günther:

Was mir nur fehlt ist, zumindest bei DI, eine tiefere Integration in die IDE, so dass das Refactoring auch die Doku entsprechend aktualisiert. Wenn man mal einen Member umbenennt, bekommt die Doku das nicht mit...

Der ModelMaker Code Explorer benennt auf Wunsch auch die Vorkommen des Bezeichners in Kommentaren mit um.

[himitsu]

Und, wie ist die Entscheidung nun ausgefallen?

Zitat von Der schöne Günther:

Die IDE bietet doch standardmäßig an, die Doku-Blöcke zusammenzufalten, auch ohne $REGION . Und wenn die einen grundsätzlich stören, gibt es auch Rechtsklick doch auch einen Punkt "Alle Doku-Blöcke zusammenfalten".

Nein, nicht überall.

In XE3 funktioniert das, aber in XE merkte ich grade erst wieder, daß Dieses noch keine /// -Bereiche zusammenfalten kann, obwohl das Help-Insight es schon seit der letzten Version erkennt und anzeigt.
Ausblenden kann XE nur Regionen und damit auch die entsprechenden ummantelten Kommentare.
Und ab mindestens XE3 gibt es dort auch den Menüeintrag Ausblenden > Dok-Kommentare.


Hmmm, auf der aktuellen Documentation Insight 3-Roadmap fand ich jetzt gerade aber keinen Punkt für das Auslagern.
[edit]
So, jetzt auch den anderen Thread wiedergefunden und in den Polls ... da haben wohl noch nicht genügend für so ein Feature gevotet.


[edit2]
Ich seh grad, daß man im aktuellen DI die Dokumentation ins Projektverzeichnis/Projektgruppe ausgelagern kann.
Allerdings kann ich das nur für die Vollversion/Trial bestätigen und nicht für die abgespeckte Emba-Edition, da in der XE6-Trial scheinbar kein DI dabei ist.
[edit3] XE6SetupDVD\Install\docinsight installer.7zip ... scheinbar wohl nur nicht in der Trial installiert.


Ach ja:
http://www.delphipraxis.net/166479-k...usblenden.html
http://www.delphipraxis.net/171454-d...ml#post1190285 > Thema zum Ausblenden