2016-01-20 9 views
5

Ich habe in Delphi 2007 einige Probleme in Bezug auf die XML-Dokumentation. Manchmal funktioniert es, manchmal nicht. Im Moment funktioniert es fast nie. Ich habe bemerkt, dass es similar Problems already mentioned gibt, aber diese Problemumgehungen funktionieren nicht für mich. Hat jemand eine Idee, wie der HelpInsight-Bug behoben werden kann oder welche Alternative ich habe, um den Quellcode zu dokumentieren, damit er in der IDE sichtbar ist?XML-Dokumentation in HelpInsight funktioniert nicht immer

Hier ist nur ein Beispiel. In diesem Beispiel funktionieren 3/4 Dokumentationen. In meinem realen Projekt arbeiten vielleicht 1-2 von 50.

enter image description here


aktualisieren Einige weitere Screenshots:

Dies ist ein normaler Vorgang in einer Klasse

enter image description here

und das Verfahren wird irgendwo anders in der Klasse aufgerufen .

enter image description here

Keine Hilfe wird in HelpInsight zur Verfügung gestellt.

Antwort

0

Der Fehler, den Sie beschreiben, ist ein Fehler, der zumindest in Delphi 2010 behoben ist, aber in Delphi XE4 behoben (Ich habe XE..XE3 nicht installiert und kann nicht testen). Sie haben die Problemumgehung gefunden, die dem Namen der Prozedur/Funktion mit dem Namen der Einheit in der Implementierung vorangestellt ist.

auch zu beachten, wenn Sie die Prozedur an anderer Stelle im Code aufrufen, wie diese

procedure WhatEver; 
begin 
    xx 
end; 

das HelpInsight Dokument wie erwartet, zeigen, wenn die Maus über xx schwebt.

Schließlich kann keine Hilfe für Ihre Anweisung von HelpInsight bereitgestellt werden, die nur 1 oder 2 von 50 Mal funktioniert, es sei denn, Sie zeigen Beispiele.

+0

1) Dass es in XE4 behoben ist, hilft mir nicht. Wir können uns eine Migration auf eine neue Delphi-Version nicht leisten. Nicht nur die hohen Kosten des Produkts selbst, sondern auch die inkompatiblen Komponenten von Drittanbietern und die Migration auf Unicode kosten Tausende. 2) Wenn ich 'xx' irgendwo im Code anrufe, ist der Fehler immer noch gleich - in HelpInsight wird keine Hilfe angezeigt, auch wenn ich die Prozedur von' xx' zu 'Unit1.xx' ändere. –

+0

3) Ich kann keine echten Beispiele liefern, da dieser Fehler fast zufällig auftritt und sogar bei jedem Start von BDS verschwindet oder wieder auftritt. Und ich kann keine Quellen für dieses Projekt veröffentlichen. Allerdings habe ich den ursprünglichen Post bearbeitet und 2 neue Screenshots hinzugefügt. 4) Gibt es keine brauchbaren Lösungen von Drittanbietern, um diese Dokumentation in der IDE zu erstellen? Im Moment ist Delphi für uns fast unbrauchbar, weil wir unsere Funktionen nicht effizient dokumentieren können. –

+0

@Daniel: Wenn der Fehler in einer späteren Version behoben wurde, müssen Sie auf diese Version aktualisieren, um den Fehler zu beheben. In Bezug auf "Gibt es keine brauchbaren Lösungen von Drittanbietern?" Ist diese Frage hier off-topic, was in der [help] klar zum Ausdruck kommt. –

Verwandte Themen