Insertion de commentaires dans le code XML

Mise à jour : novembre 2007

Les commentaires de code sont des commentaires, placés dans des fichiers de code source, qui sont ensuite disponibles pour les utilisateurs de l'environnement de développement intégré (IDE) via la fonctionnalité IntelliSense.

[Visual Basic]

Les commentaires de code XML sont disponibles en Visual Basic via le séparateur ''' (trois guillemets simples). Pour plus d'informations, consultez Comment : créer une documentation XML en Visual Basic.

[C#, J#]

Vous pouvez faire appel à la fonctionnalité Documentation XML pour insérer des commentaires dans le code. Lorsque vous annotez des types et des membres définis dans les fichiers sources de vos solutions avec les commentaires de documentation XML, ces derniers sont affichés via les fonctionnalités IntelliSense, telles que :

• Liste des membres

• Informations sur les paramètres

• Infos express

Remarque :
Lors du commentaire de méthodes partielles, seuls les commentaires placés dans l'implémentation, et non la définition, apparaissent dans les fonctionnalités IntelliSense.

Pour plus d'informations, consultez Commentaires de documentation XML (Guide de programmation C#).

[C++]

Par défaut, tout commentaire figurant dans le code source et placé à la suite des délimiteurs // ou /* est affiché en regard du membre correspondant dans la liste des membres. Pour plus d'informations, consultez C++ Comments et XML Documentation (Visual C++).

Lorsque vous faites défiler la liste, IntelliSense affiche jusqu'à 12 lignes de commentaire dans une fenêtre indépendante ouverte en regard du membre en surbrillance. Lorsqu'il existe plusieurs commentaires pour une même fonction, IntelliSense détermine celui qui doit être affiché dans la liste des membres en fonction de l'endroit où il apparaît dans le code :

1. IntelliSense affiche en premier les commentaires de fin de ligne de la déclaration. Par exemple :

   void MyFunction();   //EOL declaration comments
   

2. Si la fonctionnalité IntelliSense ne trouve pas le précédent type de commentaire, elle affiche les commentaires apparaissant directement au-dessus de la déclaration (sans séparation par des lignes vides). Par exemple :

   //Before declaration comments
      void MyFunction();
   

3. Si la fonctionnalité IntelliSense ne trouve pas les deux précédents types de commentaires dans le code, elle affiche les commentaires de fin de ligne de la définition. Par exemple :

   int CMyAppDoc::MyVariable=2; // EOL definition comments
   

4. Si la fonctionnalité IntelliSense ne trouve aucun des précédents types de commentaires dans le code, elle affiche les commentaires apparaissant directement au-dessus de la définition (sans séparation par des lignes vides). Par exemple :

   //Before definition comments
   CMyAppDoc::MyFunction() 
   {
      return; 
   }
   

Voir aussi

Référence

Liste des membres

Autres ressources

Utilisation de la fonctionnalité IntelliSense