HelpInsight Dokumentation in Delphi 2007

Question

Ich bin mit D2007 und versuche zu dokumentieren, meine Quelle code, mit dem HelpInsight Funktion (seit D2005).Ich bin hauptsächlich daran interessiert, die HelpInsight tool-Tipps arbeiten.Von verschiedenen Web-surfen und Experimentieren habe ich Folgendes gefunden:

1. Mit der triple-slash (///) Kommentar Stil funktioniert mehr als oft der andere dokumentiert Kommentar Stile.also: {*! comment *} und {! comment }
2. Die Kommentare muss vor der Erklärung, dass Sie da sind.Für die meisten Fällen wird dies bedeuten, dass Sie Sie im interface-Abschnitt des Codes.(Die offensichtliche Ausnahme ist für die Typen und Funktionen, die nicht nur von außen zugänglich aktuellen Einheit und werden daher erklärt, in der Umsetzung blockieren.)
3. Der erste Kommentar kann nicht für eine Funktion.(d.h.Sie müssen für einen Typ - oder zumindest scheint es der parser muss gesehen haben, wie die "Typ" - Schlüsselwort vor der HelpInsight Funktion)

Obwohl diese "Regeln", die manchmal die Hilfe-insight nur nicht die Kommentare, die ich geschrieben habe.Eine Datei, die nicht die richtigen HelpInsight tool-tips, aber wenn ich die Datei in eine andere dummy-Projekt, es funktioniert einwandfrei.

Hat jemand irgendwelche andere Hinweise / tricks für die erste HelpInsight zu arbeiten?

Answer 1

Ich habe entdeckt, ein weiterer Nachteil (der in meinem Fall war das, was war "falsch")

Es scheint, dass die Einheit mit der HelpInsight Kommentare muss werden, die ausdrücklich zu dem Projekt Hinzugefügt.Genügt es nicht, einfach das Gerät in einen Pfad, der durchsucht wird, wird beim kompilieren Sie das Projekt.

In anderen Worten, muss das Gerät in das Projekt eingebunden ist .dpr / .dproj-Datei.(Mit dem Projekt - | "zu Projekt Hinzufügen" Menü-option)