Audit d'aide

De RAD Studio
Aller à : navigation, rechercher

Remonter à Menu Voir


Affiche un conseil contenant des informations sur le symbole, telles que le type, le fichier, l'emplacement de la déclaration, ainsi que la documentation XML associée au symbole (s'il y a lieu). C'est aussi valable pour les classes génériques. Les informations d'exception et le numéro de ligne sont affichés pour les tableaux et les ensembles.

D'autres façons d'invoquer l'audit d'aide consiste à placer la souris au-dessus d'un identificateur dans l'éditeur de code ou à appuyer sur Ctrl+Maj+H.

Exemple de fonction :

Dans l'exemple suivant, l'audit d'aide affiche les commentaires XMLDOC pour une fonction. Vous pouvez voir comment écrire les informations de paramètres (la balise <param>) et les informations d'exceptions (la balise <exception>) :

XML Doc Comment Help Insight for Function.PNG

Exemple de classe

Dans l'exemple suivant, l'audit d'aide affiche les commentaires XMLDOC pour une classe. Vous pouvez voir comment faire des références (la balise <see>) et des remarques (la balise <remarks>) :

XML Doc Comment Help Insight.PNG

Voir Aussi