Freigeben über

Kommentare in Code (Visual Basic)

Beim Lesen der Codebeispiele wird häufig das Kommentarsymbol (') angezeigt. Dieses Symbol weist den Visual Basic-Compiler an, den darauf folgenden Text oder den Kommentar zu ignorieren. Kommentare sind kurze erklärende Notizen, die dem Code hinzugefügt werden, um das Verständnis für Leser zu erleichtern.

Es empfiehlt sich, alle Verfahren mit einem kurzen Kommentar zu beginnen, der die funktionalen Merkmale des Verfahrens beschreibt (was es tut). Dies ist für Ihren eigenen Vorteil und den Vorteil aller anderen Personen, die den Code untersuchen. Sie sollten die Implementierungsdetails (wie das Verfahren funktioniert) von Kommentaren trennen, die die funktionalen Merkmale beschreiben. Wenn Sie Implementierungsdetails in die Beschreibung einschließen, denken Sie daran, sie beim Aktualisieren der Funktion zu aktualisieren.

Kommentare können nach einer Anweisung in der gleichen Zeile eingefügt werden oder eine ganze Zeile belegen. Beide werden im folgenden Code veranschaulicht.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

Wenn Ihr Kommentar mehr als eine Zeile erfordert, verwenden Sie das Kommentarsymbol in jeder Zeile, wie im folgenden Beispiel dargestellt.

' This comment is too long to fit on a single line, so we break 
' it into two lines. Some comments might need three or more lines.

Kommentarrichtlinien

Die folgende Tabelle enthält allgemeine Richtlinien für die Typen von Kommentaren, die einem Codeabschnitt vorangehen können. Dies sind Vorschläge; Visual Basic erzwingt keine Regeln zum Hinzufügen von Kommentaren. Schreiben Sie, was am besten funktioniert, sowohl für Sie als auch für alle anderen Personen, die Ihren Code lesen.

Kommentartyp Kommentarbeschreibung
Zweck Beschreibt, was das Verfahren bewirkt (nicht wie es funktioniert)
Annahmen Listet jede externe Variable, jedes Steuerelement, eine geöffnete Datei oder ein anderes Element auf, auf das über die Prozedur zugegriffen wird.
Effekte Listet jede betroffene externe Variable, jedes Steuerelement oder jede Datei auf, und die Auswirkung, die sie hat (nur, wenn sie nicht offensichtlich ist)
Eingänge Gibt den Zweck des Arguments an.
Rückkehr Erläutert die von der Prozedur zurückgegebenen Werte.

Denken Sie an die folgenden Punkte:

  • Jeder wichtigen Variablendeklaration sollte ein Kommentar vorangestellt werden, der die Verwendung der deklarierten Variablen beschreibt.

  • Variablen, Steuerelemente und Prozeduren sollten eindeutig so benannt werden, dass kommentare nur für komplexe Implementierungsdetails erforderlich sind.

  • Kommentare können einer Zeilenfortsetzungssequenz in derselben Zeile nicht folgen.

Sie können Kommentarsymbole für einen Codeblock hinzufügen oder entfernen, indem Sie eine oder mehrere Codezeilen auswählen und auf der Symbolleiste ") und "The Visual Basic Comment button in Visual Studio.Kommentar aufheben) auswählen.The Visual Basic Uncomment button in Visual Studio.

Hinweis

Sie können Ihrem Code auch Kommentare hinzufügen, indem Sie dem Text das REM Schlüsselwort vorangehen. Das ' Symbol und dieKommentar-Auskommentierungsschaltflächen/ sind jedoch einfacher zu verwenden und benötigen weniger Speicherplatz und Arbeitsspeicher.

Siehe auch