Partager via


Assistance utilisateur pour les composants

Vous devez fournir à vos utilisateurs une assistance et une documentation sur les composants que vous créez. Vous pouvez fournir cette assistance au moment du design, par le biais de métadonnées descriptives et au moment de l'exécution en appelant l'aide HTML.

Vous pouvez fournir des informations descriptives sur votre composant en recourant aux attributes. Les attributs sont des classes spécialisées attachées à d'autres classes ou membres de classe et émises vers des métadonnées au moment de la compilation. Ils peuvent fournir des informations à l'utilisateur ou directement à l'environnement de développement. Par exemple, l'attribut DescriptionAttribute, lorsqu'il est attaché à une propriété ou à un événement, affiche une brève chaîne descriptive dans la fenêtre Propriétés. D'autres attributs affectent la manière dont l'environnement de développement se comporte avec le composant. Par exemple, l'attribut BrowsableAttribute détermine si une propriété apparaît dans la fenêtre Propriétés.

En général, un composant ne fournit pas d'assistance à l'exécution, mais cela peut dans certains cas s'avérer utile. Par exemple, un composant très gros et complexe peut posséder une aide intégrée de sorte que les développeurs n'aient pas à écrire une importante documentation. La classe Help du .NET Framework encapsule le moteur HTML Help 1.x et peut être utilisée pour fournir de l'aide à vos utilisateurs au moment de l'exécution par le biais de fichiers HTML ou .chm. Pour plus d'informations, consultez Comment : spécifier un fichier d'aide pour votre composant.

Dans cette section

Rubriques connexes

Voir aussi

Référence

Help