Kommentare und lesbarer Quelltext#

Einführung · Lektion 4 von 60

Voraussetzungen: Erstes Programm. Lernziel: Du nutzt Kommentare, ohne Programmcode versehentlich zu verstecken.

Ein Kommentar ist eine Anmerkung im Quelltext, die nicht als Programmanweisung ausgeführt wird. Kommentare helfen Menschen, Entscheidungen zu verstehen. Sie eignen sich für Begründungen, Annahmen und kurze Hinweise.

Einzeilige Kommentare#

// beginnt einen Kommentar bis zum Ende der Zeile. Er kann alleine oder hinter einer Anweisung stehen.

1#include <iostream>2 3int main() {4    // Jede Begruessung bekommt eine eigene Zeile.5    std::cout << "Hallo!\n"; // Ausgabe an die Konsole6    return 0;7}

Der Kommentar wird nicht ausgegeben. Dafür müsstest du ihn als Text an std::cout übergeben. In "https://example.org" beginnt // keinen Kommentar, weil es innerhalb eines Stringliterals steht.

Mehrzeilige Kommentare#

/* beginnt einen Blockkommentar, */ beendet ihn. Er kann sich über mehrere Zeilen erstrecken oder zwischen Teilen einer Zeile stehen.

1/*2Dieses Programm demonstriert einen Blockkommentar.3Die folgende Funktion bleibt ausfuehrbarer Code.4*/5int main() {6    return 0;7}

Blockkommentare lassen sich nicht ineinander verschachteln. Verschachteln bedeutet, eine gleichartige Struktur in eine andere einzubauen. Das erste */ beendet den Kommentar. Bereits vorhandene Blockkommentare können deshalb ein großflächiges „Auskommentieren“ kaputtmachen. Auskommentieren heißt, Code vorübergehend zu Kommentartext zu machen. Für ganze ausgewählte Zeilen ist die //-Kommentarfunktion deines Editors häufig übersichtlicher.

Gute und unnötige Kommentare#

// Gibt Hallo aus über std::cout << "Hallo"; wiederholt nur den sichtbaren Code. Eine Begründung wie // Der Automat verlangt Preise in ganzen Cent. erklärt dagegen eine Entscheidung, die aus einer Rechnung nicht hervorgeht.

Ein guter Variablen- oder Funktionsname kann Kommentare ersetzen. Bezeichner nennt man die selbst gewählten Namen im Programm. gesamtpreis ist verständlicher als x, wenn es tatsächlich um einen Gesamtpreis geht. Erkläre ungewöhnliche Einheiten, etwa Millisekunden statt Sekunden, direkt an der betreffenden Stelle.

Fehler und Grenzen#

Bei einem fehlenden */ meldet der Compiler beispielsweise unterminated comment, also einen nicht abgeschlossenen Kommentar. Ein versehentliches // vor der einzigen Ausgabe kann dagegen ein gültiges Programm erzeugen, das nichts mehr anzeigt.

Schreibe keine Passwörter oder Zugangsschlüssel in Kommentare. Quelltext wird oft kopiert oder geteilt. Entferne alten Code, statt immer größere auskommentierte Blöcke anzusammeln. Eine Versionsverwaltung wie Git speichert Änderungsgeschichte und ist für alte Fassungen besser geeignet.

Übung#

Was gibt std::cout << "/* Hallo */"; aus?

Weiterlernen#

Zurück: Dein erstes Programm – Zeichen für Zeichen · Kursübersicht · Weiter: int main(), void und der Rückgabewert