Création du fichier source XMLComments.cs
Le fichier XMLComments.cs est le fichier source utilisé pour créer le nom du document XML. Les balises XML et le texte associé sont commentés dans le code C# et un document XML est créé à partir de ces éléments lorsque le fichier source est compilé.

Remarque: La marque de commentaire XML est nouvelle dans le langage C#. Trois barres obliques (///) au début d'une ligne indiquent au compilateur que le texte qui suit est un commentaire XML. Chaque ligne de commentaire doit donc impérativement commencer par trois barres obliques. Les commentaires doivent être mis en forme avec des balises XML afin qu'il soit possible de générer un fichier XML à partir de ces données.

- Cliquez sur File puis sur Add New Item. La fenêtre Add New Item s'affiche (figure 3).
- Dans le volet Categories, cliquez sur Local Project Items, et dans le volet Templates, cliquez sur Code File.
- Tapez XMLComments.cs dans le champ du nom.

Remarque: Le nom de ce nouvel élément ne contient pas d'espace entre « XML » et « Comments ».

figure 3. Fenêtre Ajouter un nouvel élément

- Cliquez sur Open.
- Tapez le code suivant dans la page :

using System;

class XmlElement
{
/// <summary>
/// Renvoie l'attribut avec le nom donné et
/// l'espace de noms</summary>
/// <param name="name">
/// Nom de l'attribut</param>
/// <param name="ns">
/// Espace de noms de l'attribut, ou nul si
/// l'attribut n'a pas d'espace de noms</param>
/// <return>
/// Valeur de l'attribut, ou nul si l'attribut
/// n'existe pas</return>
/// <seealso cref="GetAttr(string,string)"/>
  public string GetAttr(string name, string ns) {
    return "test";
  }
}

- Cliquez sur File, puis sur Save XMLComments.cs (ou cliquez sur l'icône Save). Le fichier est enregistré dans le dossier de votre projet.
- Cliquez sur File, puis sur Exit. Si la fenêtre Développement Microsoft s'affiche, cliquez sur Yes pour enregistrer les modifications du projet.

Ouverture du projet et du fichier source dans l'IDE
- Cliquez sur Démarrer, Programmes, Microsoft Visual Studio .NET, puis sur Microsoft Visual Studio .NET.
- Cliquez sur File, Open, puis Project.
- Développez le répertoire C:\Documents and Settings\Administrator\My Documents\Visual Studio Projects\XMLComments.
- Cliquez sur XMLComments.csproj ou sur XMLComments.sln, puis choisissez Open.
Remarque: Le fait de cliquer sur un de ces deux fichiers ouvre le projet.
Si le fichier source ne s'ouvre pas dans la fenêtre principale, double-cliquez sur l'icône XMLComments.cs dans la fenêtre Solution Explorer (figure 4). Le fichier source s'ouvre dans la fenêtre principale. Laissez l'IDE ouvert le temps d'exécuter la procédure suivante.

figure 4. Vue IDE du document XMLComments.cs

Remarque: L'espace de noms System est déclaré au tout début du fichier. Toutes les classes de cet espace de noms sont disponibles pour la classe XmlElement.
Les éléments XML nommés « param » ont des attributs nommés name et ns. Les valeurs de ces attributs sont passées à la méthode GetAttr() dans le code C# sous les commentaires.

Page: 1 | 2 | 3 | 4

Initialement publié sur MSDN France le 18 janvier 2002