Table des matières:

Comment ajouter des commentaires au XML dans Visual Studio ?
Comment ajouter des commentaires au XML dans Visual Studio ?

Vidéo: Comment ajouter des commentaires au XML dans Visual Studio ?

Vidéo: Comment ajouter des commentaires au XML dans Visual Studio ?
Vidéo: C# ep 02 Commentaire et documentation 2024, Novembre
Anonim

Pour insérer des commentaires XML pour un élément de code

  1. Tapez /// en C#, ou ''' dans Visual Basic .
  2. Dans le menu Edition, choisissez IntelliSense > Insérer un commentaire .
  3. À partir du menu contextuel ou du clic droit sur ou juste au-dessus de l'élément de code, choisissez Snippet > Insérer un commentaire .

De plus, comment écrire des commentaires en XML ?

Si tu veux commenter une seule ligne dans le XML code, insérez votre curseur au début d'une ligne que vous souhaitez commenter dehors. Tapez un symbole inférieur à suivi d'un point d'exclamation et de deux tirets. Déplacez votre curseur à la fin de la ligne, puis tapez deux tirets suivis d'un symbole supérieur à.

On peut aussi se demander, comment commenter du code en C# ? À code une commenter , tapez une double barre oblique suivie du commenter . Vous pouvez utiliser cette technique pour ajouter un commenter sur sa propre ligne ou pour ajouter un commenter après le code sur une ligne. Souvent quand vous code , vous voudrez peut-être commenter sur un bloc entier de code déclarations.

Deuxièmement, que sont les commentaires XML en C# ?

L'un d'eux est XML Documentation commentaires , appelé quelques fois Commentaires XML , qui commence par une triple barre oblique - ///. Commentaires XML peut être utilisé par la fonctionnalité IntelliSense de Visual Studio et VS Code pour afficher des informations sur un type ou un membre; ces informations proviennent de ce que vous mettez dans la documentation de votre code.

Comment documenter le code ?

Bonnes pratiques pour la rédaction de la documentation:

  1. Inclure un fichier README qui contient.
  2. Autoriser le suivi des problèmes pour les autres.
  3. Rédiger une documentation API.
  4. Documentez votre code.
  5. Appliquer les conventions de codage, telles que l'organisation des fichiers, les commentaires, les conventions de nommage, les pratiques de programmation, etc.
  6. Inclure des informations pour les contributeurs.

Conseillé: