webentwicklung-frage-antwort-db.com.de

Wie füge ich eine Beschreibung zu Funktionen und Funktionsparametern hinzu?

Ich schreibe eine VB.NET-Funktion mit einer Menge Überladungen. Ich habe gesehen, dass die meisten .NET-Funktionen Parameterbeschreibungen in IntelliSense haben. Zum Beispiel, wenn Sie String.Compare(, Sagt IntelliSense Compares two specified System.String objects and returns... Du hast die Idee. Diese Beschreibung ändert sich und Sie klicken sich durch verschiedene überladene Versionen derselben Funktionen. Wenn Sie etwas für einen Parameter eingeben, wird auch der Parameter beschrieben, den Sie gerade eingeben. Beispiel: strA: The first string to compare..

Wie kann ich meine Funktionen beschreiben?

39
Phonon

Sie müssen lediglich drei Apostrophe in der Zeile vor Ihrer Funktion eingeben. .NET fügt den Rest des Codes für Sie hinzu. Fügen Sie den Text, der im Intellisense angezeigt werden soll, in das Tag ein.

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

Für die Parameter ...

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

Klicken Sie mit der rechten Maustaste auf einen Methoden-/Mitgliedsnamen und wählen Sie im Kontextmenü die Option "Kommentar einfügen".

Der Inhalt der XML-Datei für das Mitglied/die Methode wird in einigen Versionen von Visual Studio in Intellisense-Hinweisfenstern angezeigt.

    ''' <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

Verwenden Sie XML-Kommentare. Es gibt einige vordefinierte Tags, die nach dem Kompilieren in Intellisense geladen werden. und das Wunderbare ist, wenn Sie den Cursor auf die Zeile über Ihrer Funktion setzen, dann drücken Sie '' '(dreifaches einfaches Anführungszeichen, wenn das Sinn macht) und geben Sie ein, es wird eine Menge Dinge für Sie vorfüllen. Hier ein Artikel:

Dokumentieren Sie Ihren Code mit XML-Kommentaren

7
rigamonk

Positionieren Sie den Cursor in der Zeile vor der Methode und geben Sie drei Apostrophe ein ('''). Sie erhalten eine Vorlage zum Schreiben von XML-Dokumentation für die Methode und ihre Parameter.

3
Guffa