Visual Basic .NET: Programmiertechniken

Aus Wikibooks

In der Folge werden wir uns mit nützlichen und häufig wiederkehrenden Programmiertechniken beschäftigen. Dazu werden wir immer nur den Inhalt von Main verändern. Sie können die Beispiele in den folgenden Lektionen nachvollziehen, indem Sie die 2 Befehle in der Funktion Main durch den dort angegebenen Inhalt ersetzen. Alternativ können Sie auch neue Projekte anlegen, so wie es in der Einführung beschrieben wurde.

Vorher werden wir jedoch schnell ein nützliches Feature kennenlernen, das nur dem Programmierer dient und am eigentlichen Programm gar nichts ändert. Werfen Sie einen Blick auf die folgenden zwei Quelltexte, die exakt dasselbe Programm beschreiben.

Code:  

Module Module1

    Sub Main()
        System.Console.WriteLine("Hello world.")
        System.Console.ReadLine()
    End Sub

End Class

Dieser Code ist – was das Programm selbst betrifft – durchaus korrekt. Aber im Vergleich mit dem folgenden Code ist er schlechter verständlich und deshalb ungünstig:

Code:  

Module Module1

    Sub Main()
    'Ein klassisches Hello-World-Programm.
        System.Console.WriteLine("Hello world.")    'gibt die Nachricht aus
        System.Console.ReadLine()                   'verhindert, dass die Konsole sofort geschlossen wird
    End Sub

End Class

Der zweite Code wurde um Kommentare erweitert. Diese erscheinen nur im Quelltext und nicht im fertigen Programm. Alles, was in einer Zeile hinter einem Apostroph (auf der Tastatur über die Rautetaste bei gedrückter Umschalttaste erreichbar) steht, ist auskommentiert. Dies kann zwei Gründe haben: Einerseits dienen Kommentare der Dokumentation, indem sie wie oben den Code erklären. Dies ist bei größeren Projekten hilfreich, oder wenn Sie sich mit einem Programm lange nicht mehr befasst haben. Kommentare helfen dann, den Code schneller zu verstehen, um effektiv weiterzuarbeiten.

Dabei kommt es vor allem auf die Qualität der Kommentare an: Gute Kommentare erklären nicht, was der Code macht, sondern warum er es macht. Das heißt auch, dass die Kommentare im obigen Beispiel schlecht sind, da sie nur das Offensichtliche erklären, nämlich was der Code macht. (Schließlich dienten diese Kommentare auch nur Demonstrationszwecken.) Eine Ausnahme ist lediglich der Kommentar hinter dem ReadLine-Befehl.

Die zweite Einsatzmöglichkeit für Kommentare besteht darin, Code auszukommentieren. Wenn Sie z.B. einen Fehler suchen und nicht wissen, an welchem Befehl es liegt, müssen Sie die Befehle nicht einzeln löschen und wiederherstellen, sondern können die zweifelhaften Befehle zu Versuchszwecken auskommentieren, d.h. Apostrophe davorsetzen. Sie können auch ganze Funktionen auskommentieren, wenn diese gerade nicht gebraucht werden, Sie sich aber nicht sicher sind, ob Sie die Funktionen oder Teile davon nicht wiederverwenden können, oder wenn Sie eine Funktion neuschreiben wollen, die alte Version aber zum Vergleich behalten wollen.

Die Codebeispiele in diesem Buch werden meistens keine Kommentare enthalten, da sie sowieso ausführlich erklärt werden.