web-dev-qa-db-fra.com

Comment ajouter une description aux fonctions et paramètres de fonction?

J'écris une fonction VB.NET avec une tonne de surcharges. J'ai vu que la plupart des fonctions .NET ont des descriptions de paramètres dans IntelliSense. Par exemple, lorsque vous saisissez String.Compare(, IntelliSense dit Compares two specified System.String objects and returns... vous avez eu l'idée. Cette description change et vous cliquez sur différentes versions surchargées des mêmes fonctions. Lorsque vous commencez à saisir quelque chose pour un paramètre, il décrit également le paramètre que vous entrez actuellement. Exemple: strA: The first string to compare..

Comment puis-je donner de telles descriptions à mes fonctions?

vb.netuser-defined-functions
39
Phonon

Tout ce que vous avez à faire est de taper trois apostrophes sur la ligne avant votre fonction. .NET ajoutera le reste du code pour vous. Insérez le texte que vous souhaitez afficher dans l'intellisense dans la balise.

''' <summary>
''' Returns the name of the code.
''' </summary>
Function GetName() As String
    Return "Something"
End Function
69
Jeff Stock

Pour les paramètres ...

''' <summary>
''' Procedure description
''' </summary>
''' <param name="someVariable">someVariable description.</param>
''' <param name="someVariable">someVariable description.</param>
''' <remarks></remarks>
37
Jack

Cliquez avec le bouton droit sur un nom de méthode/membre et choisissez "Insérer un commentaire" dans le menu contextuel.

Le contenu du XML du membre/de la méthode sera affiché dans certaines versions de Visual Studio, à l'intérieur des fenêtres de conseils d'intellisense.

    ''' <summary>
    ''' Summary for the method goes here
    ''' </summary>
    ''' <param name="value">Param comments go here</param>
    ''' <remarks></remarks>
Private Sub SomeMethod(ByVal value As Decimal)
21
Smudge202

Utilisez des commentaires xml. Il existe des balises prédéfinies qui se chargent dans intellisense après la compilation. et la chose merveilleuse est, si vous placez votre curseur sur la ligne au-dessus de votre fonction, puis appuyez sur '' '(citation triple simple, si cela a du sens) et entrez, cela pré-remplira un tas de choses pour vous. Voici un article:

Documentation de votre code avec des commentaires XML

7
rigamonk

Placez le curseur sur la ligne avant la méthode et tapez trois apostrophes ('''). Vous obtiendrez un modèle pour écrire de la documentation XML pour la méthode et ses paramètres.

3
Guffa