Kommentare in Code
Aktualisiert: November 2007
Wenn Sie die Codebeispiele lesen, werden Sie oft auf das Kommentarsymbol (') stoßen. Dieses Symbol weist den Visual Basic-Compiler an, den darauf folgenden Text, also den Kommentar, zu ignorieren. Kommentare sind kurze, erläuternde Hinweise, die dem Code zum Zwecke der besseren Verständlichkeit hinzugefügt werden.
Es gilt als guter Programmierstil, alle Prozeduren mit einem kurzen Kommentar zu beginnen, der die Funktionsmerkmale der Prozedur (ihre Aufgabe) beschreibt. Dies ist zu Ihrem eigenen Nutzen und zum Nutzen jeder anderen Person, die den Code liest. Dabei ist es sinnvoll, die Einzelheiten der Implementierung, d. h., wie die Prozedur funktioniert, von den Kommentaren abzugrenzen, in denen die funktionalen Eigenschaften beschrieben werden. Falls Sie in einem Kommentar Einzelheiten der Implementierung beschreiben, denken Sie daran, diese entsprechend zu aktualisieren, wenn Sie die Funktion ändern.
Kommentare können nach einer Anweisung in der gleichen Zeile eingefügt werden oder eine ganze Zeile belegen. Beide Fälle 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 der Kommentar mehr als eine Zeile beansprucht, verwenden Sie das Kommentarsymbol in jeder neuen Zeile, wie im folgenden Beispiel veranschaulicht.
' 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.
Richtlinien für Kommentare
Die folgende Tabelle enthält allgemeine Richtlinien für die verschiedenen Arten von Kommentaren, die einem Codeabschnitt vorangestellt werden können. Diese Richtlinien sind als Empfehlungen gedacht, da Visual Basic keine Regeln für das Hinzufügen von Kommentaren erzwingt. Wenden Sie diese Empfehlungen so an, wie sie für Sie und andere Leser am sinnvollsten sind.
Kommentartyp |
Kommentarbeschreibung |
|---|---|
Zweck |
Hier wird beschrieben, was die Prozedur bewirkt (nicht, wie sie dies bewirkt). |
Annahmen |
Listet alle externen Variablen, Steuerelemente, offenen Dateien und andere Elemente auf, auf die die Prozedur zugreift. |
Auswirkungen |
Hier werden die einzelnen betroffenen externen Variablen, Steuerelemente oder Dateien sowie deren Auswirkungen genannt (falls dies nicht offensichtlich ist). |
Eingaben |
Gibt den Zweck des Arguments an. |
Rückgabewerte |
Erläutert die von der Prozedur zurückgegebenen Werte. |
Beachten Sie Folgendes:
Vor jeder wichtigen Variablendeklaration sollte ein Kommentar stehen, der Sinn und Zweck der deklarierten Variablen beschreibt.
Variablen, Steuerelemente und Prozeduren sollten so klar benannt werden, dass Kommentare nur für komplexe Implementierungsdetails erforderlich sind.
Auf eine Zeilenfortsetzungszeichenfolge darf nicht in der gleichen Zeile ein Kommentar folgen.
Sie können Kommentarsymbole für einen Codeblock hinzufügen bzw. entfernen, indem Sie eine oder mehrere Codezeilen markieren und auf der Symbolleiste Bearbeiten auf die Schaltflächen Auswahl kommentieren (.gif)
) bzw. Auswahlkommentar löschen (.gif)
) klicken.
.gif "Hinweis") Hinweis: |
|---|
Sie können Code auch Kommentare hinzufügen, indem Sie vor dem betreffenden Text das REM-Schlüsselwort einfügen. Das '-Symbol und die Schaltflächen Auswahl kommentieren/Auswahlkommentar löschen sind jedoch einfacher zu verwenden und beanspruchen weniger Platz auf dem Bildschirm und Speicherplatz. |