Cette documentation est archivée et n’est pas conservée.

Documentation XML, exemple

Download sample

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

Note de sécuritéRemarque de sécurité

Cet exemple de code est fourni pour illustrer un concept et ne doit pas être utilisé dans des applications ou des sites Web, car il peut ne pas illustrer les pratiques de programmation les plus sûres. Microsoft n'assume aucune responsabilité pour tout dommage indirect ou consécutif en cas d'utilisation de l'exemple de code à des fins autres que celles prévues.

Pour ouvrir le fichier d'exemple dans l'Explorateur de solutions

  1. Cliquez sur Télécharger l'exemple.

    Le message Téléchargement de fichier s'affiche.

  2. Cliquez sur Ouvrir, puis dans la colonne de gauche de la fenêtre du dossier du zip, cliquez sur Extraire tous les fichiers.

    L'Assistant Extraction s'ouvre.

  3. Cliquez sur Suivant. Vous pouvez modifier le répertoire dans lequel les fichiers seront extraits, puis cliquer de nouveau sur Suivant.

    Assurez-vous que la case à cocher Afficher les fichiers extraits est activée, et cliquez sur Terminer.

  4. Double-cliquez sur le fichier .sln de l'exemple.

    La solution exemple est affichée dans l'Explorateur de solutions. Vous pouvez obtenir un avertissement de sécurité indiquant que l'emplacement de la solution n'est pas fiable. Cliquez sur OK pour continuer.

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

  1. Dans l'Explorateur de solutions, cliquez avec le bouton droit sur le projet, puis cliquez sur Propriétés.

  2. Ouvrez le dossier Propriétés de configuration, puis cliquez sur Générer.

  3. Attribuez à la propriété Fichier de documentation XML la valeur XMLsample.xml.

  4. 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.

Générer l'exemple XML Documentation à partir de la ligne de commande

  1. Pour générer l'exemple de documentation XML, tapez le texte suivant à l'invite de commandes :

    csc XMLsample.cs /doc:XMLsample.xml
    
  2. Pour afficher le code XML généré, exécutez la commande suivante :

    type XMLsample.xml
    

Voir aussi

Afficher: