HelpInsight-Dokumentation in Delphi 2007

9

Ich verwende D2007 und versuche, meinen Quellcode zu dokumentieren, indem ich die HelpInsight-Funktion verwende (seit D2005). Ich bin hauptsächlich daran interessiert, dass die HelpInsight-Tooltipps funktionieren. Aus verschiedenen Web-Surfen und Experimentieren habe ich folgendes gefunden:

  1. Der Tripelstich (///) -Kommentarstil funktioniert häufiger als die anderen dokumentierten Kommentarstile. z.B. {*! comment *} und {! comment }
  2. Die Kommentare müssen vor der Deklaration stehen, für die sie bestimmt sind. In den meisten Fällen bedeutet dies, dass sie in den Schnittstellenbereich des Codes eingefügt werden. (Die offensichtliche Ausnahme ist für Typen und Funktionen, auf die von außerhalb der aktuellen Einheit nicht zugegriffen werden kann und die daher im Implementierungsblock deklariert sind.)
  3. Der erste Kommentar kann nicht für eine Funktion sein. (d. h. es muss für einen Typ sein - oder zumindest scheint der Parser das Schlüsselwort "type" gesehen zu haben, bevor die HelpInsight-Funktion funktioniert)

Trotz der Einhaltung dieser "Regeln" finden die Hilfe-Einblicke manchmal nicht die Kommentare, die ich geschrieben habe. Eine Datei erzeugt nicht die richtigen HelpInsight-Tooltipps, aber wenn ich diese Datei in ein anderes Dummy-Projekt einfüge, funktioniert sie ordnungsgemäß.

Hat jemand noch andere Hinweise / Tricks, um HelpInsight zum Laufen zu bringen?

    
Andrew 10.09.2008, 00:04
quelle

1 Antwort

4

Ich habe eine andere Einschränkung entdeckt (was in meinem Fall war, was "falsch" war)

Es scheint, dass die Unit mit den HelpInsight-Kommentaren explizit zum Projekt hinzugefügt werden muss. Es genügt nicht, die Einheit einfach in einem Pfad zu haben, der beim Kompilieren des Projekts durchsucht wird.

Mit anderen Worten, die Einheit muss in der .dpr / .dproj-Datei des Projekts enthalten sein. (Über die Menüoption Projekt | "Zum Projekt hinzufügen")

    
Andrew 10.09.2008, 23:38
quelle

Tags und Links