Delphi 2005: Help Insight will einfach nicht

[BaumWollSchaf]

Hallo.

Hat schon jemand die Help Insight in Delphi 2005 sinnvoll nutzen können? Ich rede jetzt von selbst erstellten Kommentaren.

Ich habe mich jetzt einige Zeit mit XMLDoc und dem HelpInsightGenerator Python Script aus dem CC herumgeschlagen und komme einfach auf keinen grünen Zweig.

Mal abgesehen davon, daß die Generierung der XML-Kommentare aus Delphi heraus oft dafür sorgt, daß Delphi mir mit einer "zuwenig Arbeitsspeicher" oder "Konnte dll soundso nicht finden" abschmiert, macht mich das HelpGeneratorScript wahnsinnig, weil es nichts anderes ausspuckt, als dieselben XML-Dateien, die ich bereits mit XML-Doc erstellt habe.

Ich wäre für Erfahrungen diesbezüglich sehr dankbar.

[sakura]

Help-Insight nimmt imo zZ nur Xml-Docs zu eingefügten Assemblies heran. Direkt im Code dokumentieren und im gleichen Projekt nutzen geht in dieser Version noch nicht

......

[BaumWollSchaf]

Erstmal vielen Dank für die Antwort.

Aber:



Da bin ich jetzt verwirrt. Meinst du jetzt, daß es nur mit .Net funktioniert oder überhaupt nicht?

Wenn es nämlich gar nicht ginge wäre ich schwer enttäuscht von Borland. Schließlich haben die doch behauptet, daß es funktionieren soll.

Auszug aus Interview mit Corbin Dunn über die Delphi-IDE:

Zitat:

Wie funktioniert HelpInsight? Woher kommt der Text usw.?

Wenn man die Maus über einen Bezeichner hält, findet die IDE heraus, aus welchem Assembly oder Package er kommt. Sie sucht dann nach einer XML-Datei mit dem gleichen Namen. Wenn man z.B. die Maus über System.Windows.Forms.Form hält, wird die IDE in System.Windows.Forms.xml nach Hilfeinformationen suchen, die sich im Framework-Verzeichnis befinden. Wenn man Hilfe für einen Teil aus der VCL anfordert, sucht die IDE in vcl90.xml danach.

Funktioniert das auch mit eigenen Units, Klassen und Methoden oder nur mit Borland-Code?

Man kann die XML-Dokumentationsoptionen für die Delphi- und C#-Compiler verwenden, um XML-Dokumentation zu generieren. Die IDE verlangt, dass die XML-Doc-Datei im Microsoft-Format ist; deshalb wird man eine Transformation auf die von Delphi generierten XML-Dokumentationsdateien durchführen müssen. Solange sich die Datei an derselben Stelle wie das Assembly/Package befindet, sollte die IDE sie finden. Eventuell wird die IDE die XML-Dokumentation direkt aus dem Quellcode, an dem gerade gearbeitet wird, ziehen. Dieses Feature wird jedoch nicht in Diamondback enthalten sein.

Bitte bitte sag, daß ich dich falsch verstanden habe. Oder hat Borland das Feature kurz vor Release rausgenommen? Boah, dann werd ich aber wild

[sakura]

[quote="BaumWollSchaf"]Da bin ich jetzt verwirrt. Meinst du jetzt, daß es nur mit .Net funktioniert oder überhaupt nicht?
Nein, sie gehen wohl auch in der Win32-Umgebung, da dann aber wohl auch nur für Packages, etc. Aber verlässlich kann ich es nicht sagen, da ich für dieses Feature noch nicht die nötige Zeit hatte.

Was auf jeden Fall noch überhaupt nicht geht, ist die "Live-Erstellung" im bearbeiteten Code, wie Du Corbins Statement entnehmen kannst:

Zitat:

Eventuell wird die IDE die XML-Dokumentation direkt aus dem Quellcode, an dem gerade gearbeitet wird, ziehen. Dieses Feature wird jedoch nicht in Diamondback enthalten sein.

Zitat von BaumWollSchaf:

Bitte bitte sag, daß ich dich falsch verstanden habe. Oder hat Borland das Feature kurz vor Release rausgenommen? Boah, dann werd ich aber wild

Versteh mich nicht falsch, ich habe erst mal nur meine Vermutungen basierend auf Emails geäußert, getestet habe ich es noch gar nicht.

......

[BaumWollSchaf]

Zitat von sakura:

Zitat von BaumWollSchaf:

Da bin ich jetzt verwirrt. Meinst du jetzt, daß es nur mit .Net funktioniert oder überhaupt nicht?

Nein, sie gehen wohl auch in der Win32-Umgebung, da dann aber wohl auch nur für Packages, etc. Aber verlässlich kann ich es nicht sagen, da ich für dieses Feature noch nicht die nötige Zeit hatte.

Oha, na das hört sich doch schon viel besser an. Dann kann ich ja noch hoffen.

Zitat von sakura:

Was auf jeden Fall noch überhaupt nicht geht, ist die "Live-Erstellung" im bearbeiteten Code, wie Du Corbins Statement entnehmen kannst:

Zitat:

Eventuell wird die IDE die XML-Dokumentation direkt aus dem Quellcode, an dem gerade gearbeitet wird, ziehen. Dieses Feature wird jedoch nicht in Diamondback enthalten sein.

Das hatte ich auch so verstanden, aber die interessiert mich noch nicht so derbe im Moment (auch wenn sie ein Hammerfeature wäre). Ich wäre ja schon froh, wenn die Erstellung und Nutzung der separaten XML-Dateien funktionieren würde.

Zitat von sakura:

Zitat von BaumWollSchaf:

Bitte bitte sag, daß ich dich falsch verstanden habe. Oder hat Borland das Feature kurz vor Release rausgenommen? Boah, dann werd ich aber wild

Versteh mich nicht falsch, ich habe erst mal nur meine Vermutungen basierend auf Emails geäußert, getestet habe ich es noch gar nicht.

......

Alles klar, da bin ich wohl etwas über's Ziel hinausgeschossen. Danke für deinen Kommentar.

Vielleicht hat ja noch jemand Erfahrungen damit gemacht. Mich wundert sowieso, daß anscheinend an diesem Feature kein so starkes Interesse besteht. Im Netz findet man recht wenig zu dem Thema, und die meisten scheinen an den Python Scripts zu scheitern.

[Robert_G]

Zitat von BaumWollSchaf:

Vielleicht hat ja noch jemand Erfahrungen damit gemacht. Mich wundert sowieso, daß anscheinend an diesem Feature kein so starkes Interesse besteht. Im Netz findet man recht wenig zu dem Thema, und die meisten scheinen an den Python Scripts zu scheitern.

Wie, was, ... Python Script?
Ich will öffentlichen Typen und deren Methoden / Eigenschaften Doku-Tags verpassen. In einem Projekt (das das Package verwenden soll) will ich dann nicht nur sehen, welchen Typ das Objekt hat und wo es deklariert wird, ich will auch die <summary> sehen! OHNE ewig rumzufriemeln.
Genau das hat noch nie funktioniert! Wobei ich nur die Trial verwendet habe (, anhand der ich mich gegen eine berufliche Zukunft mit Delphi entschieden habe).
Ich packe meine Klassen eigentlich immer in Packages, deshalb hätte es ja _eigentlich_ funktionieren sollen. Oder war das nur eine Macke der Trial?
Für private Delphi-Basteleien würde ich mir gerne ein Update auf die D2005-Pro zulegen (privat brauche ich keine Arch. ), wäre gut zu wissen wenn dieses HelpInsight nicht nur ein sinnlos großes PopUp mit sinnlosen Infos ist.

[BaumWollSchaf]

@Rovert_G

Im Grunde sollte das was du (und ich erst) möchtest ja auch funktionieren, bloß leider nur mit einer vorherigen Umwandlung der vom Compiler erzeugten XML-Dateien (Compileroption des Projekts -> "XML-Dokumentation erzeugen").

Diese Umwandlung geht eben leider erst über XMLDoc, was im Demos Ordner liegt (und ein dreckiges Python Script ist ) und danach der Weiterbearbeitung mit dem HelpInsight Tool (wieder ein Python-Script).

Anleitungen dazu habe ich hier gefunden:

XMLDoc

und

HelpInsight-Tool

Vielleicht versucht es ja noch jemand aufgrund dieser Anstöße und kann mehr in Erfahrung bringen. Ich bin bis zur Nutzung des HelpInsight-Tools gedrungen, aber das wollte nicht so wie ich.

Wenn es eine ganz andere Variante gäbe, wäre ich ja noch sehr viel glücklicher, aber ich habe bisher leider keine Alternative entdeckt. Wenn ich wenigstens wüßte, wie so eine XML-Datei auszusehen hat, damit Delphis HelpInsight diese nutzt, wäre mir auch schon sehr geholfen.

[BaumWollSchaf]

Wäre echt schade, wenn das hier unterginge.

Möchte sich nicht vielleicht doch noch jemand daran versuchen?