Kommentare im Quellcode

In der Artikelserie Einblicke in die Software Entwicklung hast Du einige  Konzepte und Basiselemente bereits kennengelernt. Im letzten Artikel drehte sich alles um die  Operatoren. Heute stehen alles im Zeichen von Kommentaren im Quellcode!

Warum Kommentare schreiben?

Sobald Du etwas Praxiserfahrung gesammelt hast, werden Dir viele Dinge sehr leicht fallen. Programmieren wirkt zwar kompliziert, ist es aber grundlegend nicht! Sicher, es kann anstrengend sein, wenn etwas nicht funktioniert. Aufgeräumte, gut strukturierte Software mit zu schreiben bedarf zudem Erfahrung. Die einzelnen Zeilen zu programmieren, fällt jedoch schnell sehr leicht. Und da lauert die Gefahr.

Während Du eine Funktion, Methode oder Sonstiges entwickelst, bist Du »voll im Thema«. Das kann schon nach einigen Wochen anders aussehen. Sicher ist nicht jede Stelle im Code dann unverständlich. Allerdings ist die Bedeutung einzelner Stellen oder  Zusammenhänge nicht mehr direkt ersichtlich. Gut, wenn man für diesen Fall mit Kommentaren vorgesorgt hat!

Lesbarkeit von Quellcode

Über die Kunst lesbaren Quellcode zu schreiben, findest Du viele Bücher beim Buchhändler Deines Vertrauens. Das lässt sich nicht in einem Absatz erklären. Grundlegend kannst Du Dir jedoch merken, dass gut lesbarer Quelltext wie ein Text gelesen werden kann. Verschiedene Faktoren spielen dort eine Rolle.

Elementar wichtig sind sprechende Namen. Funktionen, Methoden, Objekte, Klasse, Parameter und ähnliches sollen bereits durch den Namen ihren Hintergrund deutlich machen. Auf kryptische Abkürzungen immer verzichten! Es gibt noch einige weitere Faktoren, auf die wir nicht weiter eingehen.

Unsere Aufmerksamkeit gilt nun gezielt gesetzten Kommentaren! Eine Analogie dazu: Wenn eine Funktion oder Methode das Kapitel von einem Text darstellt, könnte man mit Kommentaren zusammengehörige Abschnitte markieren und eine Überschrift setzen. Darin wird deren Aufgabe dokumentiert.

Außerdem werden mit Kommentaren knifflige Stellen kenntlich gemacht. Auch übergebene Parameter werden dokumentiert, erwartete Datentypen angegeben und ähnliches.

Was genau sind Kommentare?

Ein Kommentar ist eine Anmerkung im Code, die das Verständnis erhöht. Direkt im Quellcode werden so Hinweise hinterlegt, um die Bedeutung, einen erwarteten Wert oder Vergleichbares zu dokumentieren. Das trägt zur Lesbarkeit des Quellcodes bei.

Wichtig: Der Kommentar ist für die Ausführung der Software nicht von Relevanz. Die Software läuft auch ohne Dokumentation. Ein Kommentar wird daher als solcher kenntlich gemacht, damit der Compiler oder Interpreter diesen nicht berücksichtigt. Je nach Sprache gibt es dafür unterschiedliche Wege. Hier einige Beispiele:

Wie genau die Kommentare in der Programmiersprache Deiner Wahl markiert werden, entnimmst Du am besten der Dokumentation.

Richtlinien zum Kommentieren?

Schwieriger zu definieren ist die richtige Menge von Kommentaren. Eine goldene Regel dazu lautet:

»So viel wie nötig, so wenig wie möglich«.

Das ist zugegeben schwammig. Anders ausgedrückt würde ich sagen, die Menge macht das Gift. Zuviel, und die Übersichtlichkeit leidet. Zu wenig, und man erkennt vielleicht nicht auf Anhieb die Bedeutung oder die Funktionalität an konkreten Stellen.

Ein guter Vergleich ist das gezielte markieren von einzelnen Wörtern oder Sätzen in einem Text, zum Beispiel mit Fettschrift oder durch Unterstreichen. Dort wird der optische Hinweis auch nur gesetzt, wenn die Stelle oder Textpassage für das Verständnis wichtig ist. Man versucht so, dem Leser das Überfliegen von Texten zu erleichtern. Einige Quasistandards zur Verwendung von Kommentaren, findest du im nächsten Abschnitt.

Aufgaben von Kommentaren

Es gibt standardisierte Aufgaben für Kommentare, die mehr oder weniger in jeder Programmiersprache anzutreffen sind. Zu Beginn eines Dokuments kann zum Beispiel die generelle Aufgabe der Datei hinterlegt werden. Wie schon angesprochen kann Quellcode über Kommentare unterteilt oder gegliedert werden. Auch die konkrete Bedeutung einzelner Zeilen wird über Kommentare deutlich gemacht.

Darüber hinaus werden gerade in der Entwicklungsphase noch zwei weitere Aufgaben von Kommentaren übernommen. Ein Kommentar wird nicht ausgeführt, also vom Compiler oder dem Interpreter ignoriert. Das macht man sich bei der Programmierung zu Nutze, wenn zum testen Codebereiche deaktiviert werden sollen. Auch noch offene Aufgaben werden über Kommentare hinterlegt. Hier hat sich als Stichwort »TODO« als Präfix eingebürgert.

Fazit

Kommentare gestalten Deinen Quellcode übersichtlich. Es gibt jedoch neben der reinen Funktion als Hinweis noch eine ganze Reihe weiterer Aufgaben, die Kommentare mittlerweile übernehmen. Eine wunderbare Übersicht dazu bietet der folgende Wikipedia Artikel zu Kommentaren. Wann ein Kommentar gesetzt wird, und wann besser nicht, gehört mit zum individuellen Stil und der kreativen Freiheit des Entwicklers. Vieles ergibt sich durch Programmierpraxis. Auch durch lesen von Quellcode anderer Entwickler bekommst Du ein Gefühl dafür, wann Kommentare sinnvoll sind. Im nächsten Artikel der Serie lernst Du dann Kontrollstrukturen kennen.

Schreib einen Kommentar

Your email address will not be published.