HelpInsight la documentation de Delphi 2007

Question

Je suis à l'aide de D2007 et suis en train de document de mon code source, à l'aide de la HelpInsight fonctionnalité (fourni depuis D2005).Je suis principalement intéressé à obtenir le HelpInsight outil-conseils de travail.De divers de la navigation Web et d'expérimentation, j'ai trouvé ce qui suit:

1. À l'aide de la triple barre oblique (///) commentaire de style travaille plus souvent que les autres documenté commentaire styles.c'est à dire: {*! comment *} et {! comment }
2. Les commentaires doivent précéder la déclaration qu'ils sont pour.Pour la plupart des cas, cela voudra dire de les placer dans la section de l'interface du code.(L'exception est pour les types et les fonctions qui ne sont pas accessibles depuis l'extérieur de l'unité actuelle et sont donc déclarés dans la mise en œuvre de bloc.)
3. Le premier commentaire ne peut pas être pour une fonction.(c'est à direil doit être d'un type ou, au moins, il semble que l'analyseur doit avoir vu le "type" mot-clé avant de la HelpInsight fonctionnalité fonctionne)

En dépit de ces "règles", parfois, l'Aide-insight n'a tout simplement pas trouver les commentaires que j'ai écrit.Un fichier ne produisent pas de la bonne HelpInsight outil de conseils, mais si je inclure ce fichier dans un autre mannequin projet, il fonctionne correctement.

Quelqu'un at-il d'autres pointeurs / astuces pour obtenir HelpInsight de travail?

Answer 1

J'ai découvert un autre inconvénient (qui dans mon cas est ce qui est "mal")

Il semble que l'unité avec le HelpInsight commentaires doit être explicitement ajouté au projet.Il ne suffit pas d'avoir l'appareil dans un chemin qui est recherché lors de la compilation du projet.

En d'autres termes, l'unité doit être inclus dans le Projet .rmr / .fichier dproj.(À l'aide du Projet | "Ajouter au Projet" menu option)