Kommentare

In vielen Fällen möchte man sich im Programmcode Notizen machen, die das Verständnis des Programms erleichtern oder die es einem anderen Programmierer, der vielleicht zu einem späteren Zeitpunkt den Code überarbeitet, ermöglichen, sich mit den ursprünglichen Gedanken vertraut zu machen.

Persönl. Anmerkung:

Kommentare sollten immer und ausschließlich in Englisch gemacht werden, da nur so sicher gestellt ist, dass der Kommentar auch von nicht-deutschsprachigen Programmierern verstanden wird. Ich hatte vor einigen Jahren einen exzellenten Mitarbeiter aus Prag, der für einige Zeit mit uns arbeitete. Seine vielen mitgebrachten (und sehr nützlichen) Programme waren leider ausschließlich in tschechisch kommentiert - und keiner der anderen Programmierer verstand tschechisch.

Grundsätzlich erlaubt Delphi vier verschiedene Arten von Kommentaren, wobei Kommentare überall dort im Programmcode geschrieben werden dürfen, wo ein Leerzeichen syntaktisch erlaubt ist:

Neben der oben beschriebenen grundsätzlichen Syntax gibt es noch eine weitere wichtige Regel: Kommentare dürfen nicht verschachtelt werden, wenn sie die selbe Kommentarkennung (also (* *) oder {} ) benützen. Man darf aber Kommentare, die ausschließlich die eine Möglichkeit benützen, mit der anderen Möglichkeit umklammern. Doppelschrägstrich-Kommentare sind davon nicht betroffen.

Hinweis:

Man sollte sich angewöhnen, für längere Kommentare immer dieselbe Art zu verwenden, da es nur so möglich ist, längere Teile von Code einschließlich der zugehörigen Kommentare versuchsweise aus dem Programmcode heraus zu nehmen, indem man den betroffenen Code als Kommentar kennzeichnet. Man nennt diese Vorgangsweise auch "auskommentieren".

Neben den eigentlichen Kommentaren gibt es noch eine spezielle Art von Kommentaren, die zur Steuerung des Compilers dienen: das sind so genannte Compiler-Switches und Anweisungen zur bedingten Compilation. Näheres dazu finden Sie im Delphi-Help (Stichwort "Compileranweisungen" bzw. "Compiler Directives")

Eine wichtige Frage betrifft den Stil der Kommentare und deren Länge: Grundsätzlich gilt für Kommentare die Maxime "keep it plain and simple". Kommentare sollen keine hochgestochene Belletristik sein, sondern schlicht und einfach die Gedankengänge des Programmierer widerspiegeln und Hilfestellung für das Verstehen eines Programms geben. Gerade im deutschen Sprachraum (auch wenn die Kommentare in Englisch geschrieben sind) findet man sehr oft die Angewohnheit, Kommentare möglichst kompliziert zu machen, damit der Leser des Kommentars vor Ehrfurcht über das Wissen des Programmierers erschauern möge - das ist kontraproduktiv, ein Kommentar soll helfen den Code zu verstehen und nicht ein Denkmal für den Programmierer sein.

Kommentare haben neben der eigentlichen Notiz- und Erklärungsfunktion auch noch die Funktion das Programmieren zu erleichtern. Zum einen setzt man Kommentare in den Headern von Unterprogrammen zur Dokumentation der Funktion des jeweiligen Unterprogramms ein. Hält man sich bei den Kommentaren an eine bestimmte Syntax, so können diese durch spezielle Tools automatisch zu einem Helpfile zusammengestellt werden. Zum anderen kann man Kommentare dazu verwenden, um vor der Codierung eines Algorithmus dessen Funktion als Pseudo-Code zu notieren. Dieser Pseudo-Code dient als roter Faden bei der eigentlichen Implementierung und bleibt als Kommentar im Programmcode erhalten.

Persönl. Anmerkung:

Der Editor ist nach der Installation so eingestellt, dass die Kommentare in anderer Farbe und kursiv angezeigt werden. Während die andere Farbe eine sehr gute Idee ist, ist die kursive Schrift eher kontraproduktiv, da sie sich auf Bildschirmen schlecht lesen lässt. Ich stelle daher den Delphi-Editor so ein, dass die Kommentare mit gerader Schrift angezeigt werden (Kommando Tools/Editor Options, dann den Reiter Color auswählen).