XML-Dokumentation für einen Typ oder Member erstellen

Zur besseren Dokumentation von Quellcode ist es nützlich sogenannte XML-Dokumentationskommentare einzufügen. Diese Kommentare werden dann beim Programmieren im IntelliSense Auswahlfenster oder Objektbrowser angezeigt.

  1. Vorgehensweise:
    • Cursor im Code-Editor in die Zeile über dem Typ oder Member, zu dem eine Dokumentation erstellt werden soll.
    • “‘ (drei einfache Anführungszeichen) eingeben
    • nun wird ein XML-Skelett für den Typ oder Member im Code-Editor hinzugefügt
    • die Informationen müssen immer zwischen den entsprechenden Tags stehen
    • zusätzliche Zeilen müssen immer mit “‘ beginnen
    • Intellisense zeigt immer die Infos zw. “‘

      an

  2. Beispiel:
  3. Public Class MyClass
        ''' <summary>
        ''' Beschreibung für Variable iXY, die im Intellisense-Fenster angezeigt werden soll
        ''' </summary>
        Public iXY As Integer = -1
    
        ''' <summary>
        ''' Konstruktor
        ''' </summary>
        Public Sub New()
            ' Blah
        End Sub
    End Class
    
  4. Details: MSDN Hilfe unter „Gewusst wie: Erstellen einer XML-Dokumentation in Visual Basic“

Schreibe einen Kommentar