C++-Kommentare: Best Practices für lesbaren, wartbaren Code

C++-Kommentare

Meistern Sie die Kunst des Kommentierens in C++ – lernen Sie, warum Kommentare wichtig sind, die zwei primären Stile und wie Sie sie für klareren, wartbareren Code einsetzen.

In C++ sind Kommentare Annotationen, die Entwicklern helfen, Code zu lesen und zu verstehen. Der Compiler ignoriert sie vollständig, sodass Entwickler Kontext hinzufügen, Logik erklären oder Code vorübergehend deaktivieren können.

Es gibt zwei Standardweisen, Kommentare hinzuzufügen:

• // – Einzeilige Kommentare
• /* */ – Mehrzeilige Kommentare

---

Einzeilige Kommentare

Jede Zeile, die mit // beginnt, wird als Kommentar behandelt. Zum Beispiel:

// Variable deklarieren
int a;
// Variable 'a' mit Wert 2 initialisieren
a = 2;

Im obigen Snippet sind die ersten beiden Zeilen einzeilige Kommentare, die jeden Schritt erklären. Sie können einen Kommentar auch am Ende einer Codezeile platzieren:

int a; // Variable deklarieren

---

Mehrzeilige Kommentare

Alles zwischen /* und */ ist ein Kommentar, der sich über eine oder mehrere Zeilen erstrecken kann. Beispiel:

/*
 * Variable deklarieren
 * zum Speichern des Gehalts für Mitarbeiter
 */
int salary = 2000;

Diese Syntax ist flexibel genug, um sowohl kurze als auch ausgedehnte Codeabschnitte zu dokumentieren.

---

Kommentare zum Debuggen verwenden

Kommentare können Code vorübergehend unterdrücken, was nützlich ist, um Bugs zu isolieren. Betrachten Sie das folgende Programm:

#include <iostream>
using namespace std;

int main()
{
    cout << "some code";
    cout << "error code";
    cout << "some other code";
    return 0;
}

Wenn das Programm nicht kompiliert, können Sie die problematische Zeile auskommentieren statt sie zu löschen:

#include <iostream>
using namespace std;

int main()
{
    cout << "some code";
    // cout << "error code";
    cout << "some other code";
    return 0;
}

Pro-Tipp: Die meisten IDEs erlauben schnelles Umschalten von Kommentaren – nutzen Sie Strg + / unter Windows oder Cmd + / unter macOS.

---

Warum Kommentare verwenden?

Kommentare dienen als lebendige Dokumentation, die Code für Sie und Ihre Teamkollegen über die Zeit verständlich hält. Sie sollten das „Warum“ hinter Entscheidungen klären, nicht nur wiederholen, was der Code tut.

Hinweis: Vermeiden Sie es, sich auf Kommentare zu verlassen, um schlecht geschriebenen Code zu erklären. Streben Sie nach klarer, selbsterklärender Logik und nutzen Sie Kommentare, um Kontext dort bereitzustellen, wo er notwendig ist.

Als allgemeine Regel: Verwenden Sie Kommentare, um die Begründung einer Lösung zu erklären, nicht die Mechanik der Implementierung.