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:
{*! comment *}
und {! comment }
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?
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")
Tags und Links delphi documentation ndoc