Partager via


Commentaires XML, exemple

Mise à jour : novembre 2007

Cet exemple illustre la fonctionnalité de commentaire XML de Visual Basic.

Pour obtenir des exemples et leurs instructions d'installation

  • Effectuez une ou plusieurs des opérations suivantes :

    • Dans le menu ? (Aide), cliquez sur Exemples.

      Le fichier Readme contient des informations sur les exemples.

    • Accédez au site Web Exemples Visual Studio 2008. La version la plus récente des exemples est disponible sur ce site.

    • Recherchez les exemples sur l'ordinateur sur lequel Visual Studio est installé. Par défaut, les exemples et un fichier Readme sont installés sous lecteur:\Program Files\Microsoft Visual Studio 9.0\Samples\1036. Pour les versions Express de Visual Studio, tous les exemples sont disponibles en ligne.

Pour plus d'informations, consultez Recherche des fichiers d'exemple.

.

Note de sécurité :

Cet exemple de code est destiné à illustrer un concept ; il présente uniquement le code qui se rapporte spécifiquement à ce concept. Il est possible qu'il ne réponde pas aux exigences de sécurité d'un environnement spécifique, et ne doit pas être utilisé exactement comme indiqué. Nous vous recommandons d'ajouter du code de sécurité et de gestion des erreurs afin de renforcer la sécurité et la fiabilité de vos projets. Microsoft fournit cet exemple de code « EN L'ÉTAT » sans aucune garantie.

Pour exécuter cet exemple

  • Appuyez sur F5.

Démonstrations

Cet exemple montre comment créer des commentaires XML, les consulter dans l'éditeur et y accéder par programme.

La classe Automobile définit les éléments de type suivants, chacun d'entre eux montrant un aspect différent des commentaires XML :

  • **Types   **Automobile et EngineOption

  • Propriétés   Model

  • Méthodes   Constructeurs, Upgrade, CalculateMaxTowing, WillItTow

  • Événements   NeedsTuneUp

  • Délégués   RotateTires, ReplaceSparkPlugs

  • Champs   car, modelValue

Le gestionnaire d'événements Click du bouton Create Car appelle plusieurs des membres Automobile. Lors de l'utilisation de l'IntelliSense dans l'éditeur de code, les commentaires XML sont affichés comme info-bulles.

Le gestionnaire d'événements Click du bouton List Summaries utilise la classe XmlDocument pour interroger le fichier XML qui contient les commentaires XML. Lorsque le projet est compilé, ce fichier XML est créé et stocké avec l'assembly du projet. L'onglet Compiler du Concepteur de projets vous permet de spécifier l'emplacement et le nom de ce fichier.

Voir aussi

Tâches

Comment : créer une documentation XML en Visual Basic