Comment avoir des commentaires dans IntelliSense pour une fonction dans Visual Studio ?

Question

Dans Visual Studio et C#, lorsque vous utilisez une fonction intégrée telle que ToString(), IntelliSense affiche une boîte jaune expliquant ce qu'elle fait.

Comment puis-je avoir cela pour les fonctions et les propriétés que j'écris ?

Answer 1

Pour générer une zone où vous pouvez spécifier une description de la fonction et de chaque paramètre de la fonction, tapez ce qui suit sur la ligne précédant votre fonction et appuyez sur Enter :

• C# : ///

• VB : '''

Voir Balises recommandées pour les commentaires de documentation (Guide de programmation C#) pour plus d'informations sur le contenu structuré que vous pouvez inclure dans ces commentaires.

Answer 2

Ce dont vous avez besoin, c'est commentaires xml - En gros, ils suivent cette syntaxe (telle que vaguement décrite par Solmead) :

C#

///<summary>
///This is a description of my function.
///</summary>
string myFunction() {
     return "blah";
}

VB

'''<summary>
'''This is a description of my function.
'''</summary>
Function myFunction() As String
    Return "blah"
End Function

Answer 3

Faites des commentaires XML, comme ceci

/// <summary>
/// This does something that is awesome
/// </summary>
public void doesSomethingAwesome() {}

Answer 4

Utiliser /// pour commencer chaque ligne du commentaire et faire en sorte que le commentaire contienne l'information suivante xml approprié pour le lecteur de métadonnées.

///<summary>
/// this method says hello
///</summary>
public void SayHello();

Bien que personnellement, je pense que ces commentaires sont généralement malavisés, à moins que vous ne développiez des classes dont le code ne peut être lu par ses consommateurs.

Answer 5

Ceux-ci sont appelés Commentaires XML . Ils font partie de Visual Studio depuis toujours.

Vous pouvez faciliter votre processus de documentation en utilisant GhostDoc , un module complémentaire gratuit pour Visual Studio qui génère des commentaires de documents XML pour vous. Placez simplement votre curseur sur la méthode/propriété que vous souhaitez documenter, et appuyez sur Ctrl-Shift-D.

Voici un exemple tiré de un de mes billets .

J'espère que cela vous aidera :)