Kommentare

Kommentare sind eine essenzielle Komponente beim Schreiben von C-Code, und der GNU C-Compiler (GCC) behandelt sie genauso wie der ANSI C-Standard. Kommentare ermöglichen es, den Code für Entwickler verständlicher und wartbarer zu machen. Während der Kompilierung werden sie vollständig ignoriert und haben somit keinen Einfluss auf die erzeugte ausführbare Datei.

Es gibt zwei Hauptarten von Kommentaren, die mit GCC verwendet werden können:

• Einzeilige Kommentare mit //

Diese Art von Kommentar beginnt mit zwei Schrägstrichen (//) und wird bis zum Ende der Zeile ignoriert. Alles, was nach // auf derselben Zeile steht, ist ein Kommentar und wird vom Compiler nicht beachtet.

// Dies ist ein einzeiliger Kommentar
int x = 10;  // Variable x wird auf 10 gesetzt

Vorteil: Gut für kurze Kommentare, die nur eine Zeile benötigen oder am Ende von Codezeilen stehen sollen.

Verbreitung: Diese Kommentarart wurde mit C99 eingeführt, ist aber auch in neueren GCC-Versionen verfügbar.

• Mehrzeilige Kommentare mit /* */

Mehrzeilige Kommentare beginnen mit /* und enden mit */. Sie können sich über mehrere Zeilen erstrecken, was sie nützlich für längere Beschreibungen oder Blockkommentare macht.

/* 
   Dies ist ein mehrzeiliger Kommentar.
   Er kann über mehrere Zeilen gehen und
   wird oft für längere Erklärungen verwendet.
*/
int y = 20;

Vorteil: Ermöglicht das Kommentieren größerer Codeblöcke oder das Schreiben längerer Erklärungen.

Beachte: Mehrzeilige Kommentare können nicht ineinander verschachtelt werden. Eine verschachtelte Verwendung von /* und */ führt zu einem Kompilierfehler.

Praktische Verwendung von Kommentaren

Erklärung des Codes: Kommentare helfen, den Zweck und die Funktionsweise von Code zu erläutern, was besonders bei komplexen Algorithmen und Funktionen wichtig ist.

// Berechnet die Fläche eines Kreises
double area = PI * radius * radius;

Vorübergehendes Deaktivieren von Code: Kommentare können verwendet werden, um Code auszukommentieren, ohne ihn zu löschen.

// printf("Dieser Code ist vorübergehend deaktiviert\n");

Dokumentation von Parametern und Funktionen: Entwickler kommentieren oft die Funktionalität und Parameter von Funktionen, um den Code besser verständlich zu machen.

/* 
 * Berechnet die Summe zweier Ganzzahlen.
 * Parameter: a - die erste Zahl
 *            b - die zweite Zahl
 * Rückgabewert: Die Summe von a und b
 */
int sum(int a, int b) {
    return a + b;
}

Notizen für zukünftige Änderungen: Kommentare können verwendet werden, um Notizen über geplante Änderungen oder zu behebbende Probleme hinzuzufügen.

// TODO: Diese Funktion optimieren

GCC-spezifische Hinweise zu Kommentaren

Warnungen unterdrücken: Mit GCC kannst du Warnungen und Fehler unterdrücken, indem du Kommentare mit Compiler-Direktiven verwendest. Dies ist nützlich, wenn du z.B. Code auf bestimmte Plattformen anpassen möchtest.

#pragma GCC diagnostic ignored "-Wunused-variable"

Dokumentationskommentare: Es ist üblich, spezielle Formatierungen zu verwenden, um automatisch Dokumentationen zu generieren, wie etwa Doxygen-Kommentare. Diese werden nicht vom Compiler beachtet, können aber externe Dokumentationssysteme füttern.

/**
 * Dies ist ein Doxygen-kompatibler Kommentar.
 * Er wird zur Dokumentation verwendet.
 */

Zusammenfassung

Kommentare sind eine nützliche Technik, um den Code verständlicher zu machen und die Zusammenarbeit zwischen Entwicklern zu erleichtern. Mit GCC kannst du sowohl einzeilige als auch mehrzeilige Kommentare verwenden, die vom Compiler ignoriert werden. Sie dienen dazu, den Code zu erklären, Notizen zu hinterlassen oder temporär Code zu deaktivieren, und tragen so zur besseren Wartbarkeit des Codes bei.

---

< Zurück (Makros)

< Hauptseite >

Weiter (GNU Debugger) >