Documentation XML, exemple

Article
08/21/2008

Mise à jour : novembre 2007

Cet exemple montre comment documenter du code à l'aide de code XML. Pour plus d'informations, consultez Commentaires de documentation XML (Guide de programmation C#).

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.

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.

Générer l'exemple Documentation XML dans Visual Studio

Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le projet, puis cliquez sur Propriétés.
Ouvrez le dossier Propriétés de configuration, puis cliquez sur Générer.
Attribuez à la propriété Fichier de documentation XML la valeur XMLsample.xml.
Dans le menu Générer, cliquez sur Générer.

Le fichier de sortie XML se trouve dans le répertoire de débogage.

Pour générer l'exemple XML Documentation à partir d'une invite de commandes

Pour générer l'exemple de documentation XML, tapez le texte suivant à une invite de commandes :
```
csc XMLsample.cs /doc:XMLsample.xml
```
Pour afficher le code XML généré, tapez la commande suivante :
```
type XMLsample.xml
```

Voir aussi

Tâches

Comment : utiliser les fonctionnalités de la documentation XML (Guide de programmation C#)

Concepts

Exemples Visual C#

Guide de programmation C#

Share via