Documentation Insight nutzen?

[himitsu]

Nutzt das eigentlich irgendwer intensiv? :stupid:


Nja, die abgespeckte Delphi-Edition läßt sich doch eher grausam editieren.
Mit der Vollversion sieht das aber schon anders aus.


Aber mal eine Frage dazu:
Ist es denn mal vorgesehn, daß z.B. die Dokumentation de Property und Methoden einer Klasse mit in der Dokumentation der Klasse verwaltet wird?
So wie es z.B. bei den Parametern einer Funktion der Fall ist, wo nicht bei jedem einzelnem Parameter die Dokumentation eingefügt wird, sondern über

Delphi-Quellcode:

<param name="...">

im Property landet.

Irgendwie wird durch die Dokumentation der Code mindestens doppelt so lang (wenn man es nicht zusammenfaltet, dann noch viel länger) und ich hab es bisher so gehandhabt, daß funktional zusammengehörige Property und Methoden auch im Code gruppiert waren, welches durch die Dokumentation nun föllig zerrissen wird.
Durch die alphabetische Sortierung in der Dokumentation wird dann auch da nochmal die Zusammengehörigkeit geschrottet.
(OK, man kann natürlich nun auch anfangen und jedes zweite Property in eine Unterklasse auszulagern, aber das macht den Code wieder nicht unbedingt schöner)

Da man dieses XML-Zeugs sowieso nicht manuell liest, könnten, von mir aus, die Dokumentationscodes in die Klassendoku verschoben werden, z.B. in einem

Delphi-Quellcode:

<proeprty name="...">

verpackt. (aber ich vermute mal, daß sowas aktuell nicht vorgesehn ist)

[bernhard_LA]

man benötigt schon die volle Version (DI Prof. = 249 Euro) um damit sinnvoll arbeiten zu können, die Express Version ist wohl eher nur so ein "Appetithäppchen"


Was uns im Team fehlt ist die Möglichkeit "Verzeichnisse aller Funktionen und Klassen" in unseren Projekten zu erstellen
, bei 500 K Lines of Source code verliert man schon mal den Überblick

[Uwe Raabe]

Man denkt zumindest daran, die Doku in eine separate Datei auszulagern: http://forums.devjetsoftware.com/showthread.php?tid=18

[baoquan.zuo]

Hi, Would you mind that I reply in English? I can only say "Guten tag, Ich liebe dich" but it is definitely not suitable in this case :)

At present Documentation Insight only supports inline xml documentation. We have been trying to make source code look better by using friendly layout and take advantage of the {$REGION} directive so that you could fold them in D2007 or higher. Furthermore, XMl documentation could be folded naturally in XE2 or higher.

As Uwe said and depending on our poll result (http://www.devjetsoftware.com/polls/), it seems that many guys prefer external documentation storage and we will definitely consider this support in nearly future.

The Documentation Explorer feature instantly shows the code structure of current project group. However there is still much room to improve it. such as live search, better navigation of hyperlinks, etc. That requires a lot of work but it is in our plan.

P.S. Documentation Insight 2 Professional is 99 EUR while the Enterprise version is 249 EUR. The Enterprise version includes all documentation generation features (such as web pages, CHM, Microsoft Help 2, Help & Manual).

It should be also mentioned that we are offering 20% off for the Enterprise version during CodeRage 7 (Due date: Nov 15th, 2012) If you are interested in it, please visit http://www.devjetsoftware.com/purchase/

If you have any questions/ideas, you are welcome to write to us at [e-mail]

Thanks!

[himitsu]

So, das ist nun inzwischen eingebaut. (in XE6-Trial + DI-Trial, da DI Express in der XE-Trial fehlte)
Verwendet das schon jemand?

Nur ein bissl "unglücklich" wurde das wohl umgesetzt.

• Als Erstes kommt die Meldung "Wenn ausgelagert wird, dann könne das nicht rückgängig gemacht werden", sobald man es aktiviert.
• Die Funktion zum Auslagern macht irgendwie garnichts. (die vorhandenen oder markierten Kommentare werden nicht ausgelagert)
• Wenn das einmal im Projekt aktiviert wurde, dann lässt es sich nicht mehr abschalten und gilt für alle neuen Dok-Kommentare in allen (neuen) Dateien.
  
• Für Einzel-Dateien ohne Projekt ist das absolut nicht zu gebrauchen. (Units, welche man einzeln weitergibt, bzw. Welche in mehreren Projekten verwendet werden)
• Help-Insight kommt damit garnicht klar und zeigt somit auch nichts an, was leider einer der Vorteile davon war.

Das DevJet-Forum wurde gelöscht und auf G+ fand ich bis jetzt noch nichts, zu diesem Thema.


Dann mal in Ruhe schauen, wohin man sich nun besüglich dieses Themas wenden kann. (notfalls die oben genannte eMail)
Nja, ansonsten war ich eh erstmal nur neugierig, ob/was sich eigentlich getan hat.

Aber insgesammt ist diese Art der Doku schon recht praktisch, wenn man das in der Datei belässt (was ja eh in älteren Delphis nicht dabei ist) und wenn man sich nur auf einfachen Beschreibungstext beschränkt.

Weitere Threads/Links:
http://www.delphipraxis.net/166479-k...usblenden.html
http://www.delphipraxis.net/177720-d...c-o-matic.html
http://www.devjetsoftware.com/produc...eature-matrix/ (nur daß dort das Express in der Liste fehlt)

[Stevie]

Zitat:

Zitat von himitsu (Beitrag 1257818)

Das DevJet-Forum wurde gelöscht und auf G+ fand ich bis jetzt noch nichts, zu diesem Thema.

Dann mal in Ruhe schauen, wohin man sich nun bezüglich dieses Themas wenden kann.

In der offiziellen DevJet Software Community.

Zitat:

Zitat von himitsu (Beitrag 1257818)

http://www.devjetsoftware.com/produc...eature-matrix/ (nur daß dort das Express in der Liste fehlt)

Das liegt daran, dass es seit XE6 keine Express Edition mehr gibt.

[himitsu]

Zitat:

Zitat von himitsu (Beitrag 1257778)

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.

Dann hat Emba deren Wünschen das zu entfernen dann doch nicht ganz entsprochen? (ist noch drin, aber wird nicht nur mehr installiert)

Dachte schon es fehle nur in der Trial, aber da die Datei denoch vorhanden ist ...

[Mavarik]

Zitat:

Zitat von himitsu (Beitrag 1257901)

Zitat:

Zitat von himitsu (Beitrag 1257778)

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.

Dann hat Emba deren Wünschen das zu entfernen dann doch nicht ganz entsprochen? (ist noch drin, aber wird nicht nur mehr installiert)

Dachte schon es fehle nur in der Trial, aber da die Datei denoch vorhanden ist ...

So ein Dreck... Jetzt habe ich mich endlich dazu durchgerungen das zu verwenden (seit Mitte XE5) und jetzt ist es schon wieder nicht mehr dabei...? Ist mir noch nicht aufgefallen... Genau wie die verschiedenen Reportgeneratoren.

Mavarik

[Mavarik]

Zitat:

Zitat von himitsu (Beitrag 1257901)

XE6SetupDVD\Install\docinsight installer.7zip ... scheinbar wohl nur nicht in der Trial installiert.

In der Vollversion auch nicht... Wie lautet den das 7-Zip-EMBT Passwort??? LOL...

[Stevie]

Zitat:

Zitat von Mavarik (Beitrag 1257980)

Zitat:

Zitat von himitsu (Beitrag 1257901)

XE6SetupDVD\Install\docinsight installer.7zip ... scheinbar wohl nur nicht in der Trial installiert.

In der Vollversion auch nicht... Wie lautet den das 7-Zip-EMBT Passwort??? LOL...

Ich denke eher, dass das die Version von XE5 ist, die sie nicht rausgeworfen haben, denn Paul wird ihnen kaum eine neue Version gegeben haben.