Kommentare in C meistern: Klare, effektive Notizen schreiben

Was ist ein Kommentar in C?

Ein Kommentar ist eine Erläuterung oder Beschreibung, die den Quellcode begleitet. Er hilft Entwicklern, Absichten zu kommunizieren, Lesbarkeit zu verbessern und Code über Zeit zu warten. Während der Kompilierung ignoriert der Compiler Kommentare vollständig, sodass sie die Laufzeit-Performance nicht beeinflussen.

In C gibt es zwei kanonische Stile:

1. Blockkommentare, beginnen mit /* und enden mit */. Sie können eine oder mehrere Zeilen umfassen.
2. Einzeilige Kommentare, eingeleitet durch //. Alles nach den zwei Schrägstrichen in dieser Zeile wird vom Compiler verworfen.

Einzeiliger Kommentar – Beispiel

// Dies ist ein einzeiliger Kommentar

Unten ein minimales Programm, das die Verwendung eines einzeiligen Kommentars demonstriert:

#include <stdio.h>
int main(void) {
    // Die folgende Zeile gibt eine Begrüßung aus
    printf("Guru99");
    return 0; // Exit-Status
}

Mehrzeiliger Kommentar – Beispiel

/* Beispiel für mehrzeiligen Kommentar
Zeile 1
Zeile 2
... */

Hier ein reales Snippet, das Blockkommentare mit inline Einzeilkommentaren mischt:

#include <stdio.h>
int main() {
    /* In der main-Funktion beschreibe ich die Logik
       und hebe wichtige Schritte hervor */
    int x = 42; // x ist eine Integer-Variable
    printf("%d", x);
    return 0;
}

Warum sollte man kommentieren?

Code zu schreiben, der für Menschen lesbar ist, ist ein Eckpfeiler professioneller Softwareentwicklung. Kommentare:

• Klären komplexe Logik für zukünftige Wartende.
• Dokumentieren Annahmen, Constraints und erwartetes Verhalten.
• Erleichtern Zusammenarbeit in Teams und Open-Source-Projekten.
• Beeinflussen die Programmausführung nicht, bieten aber langfristigen Wert.

Disziplinierte Kommentiergewohnheiten anzueignen, gilt als Best Practice in der Industrie und signalisiert Expertise, Sorgfalt und Qualitätsbewusstsein.