Kommentare in C++

Noch kurz zu den Kommentaren, welche man im Code einfügen sollte. Es ist wichtig  und richtig, Code zu kommentieren, und damit auch im Code zu dokumentieren. Kommentare können auch dazu verwendet werden einen bestimmten Codeblock aus dem Programm herauszunehmen.

C++ kennt 2 verschiedene Kommentare:
  • Den Standardkommentar aus C: mit /* wird alles auskommentiert, bis die Zeichensequenz */ kommt.
  • Mit // lässt sich in C++ alles bis zum Zeilenende auskommentieren.
Es gibt noch einen weiteren Kommentar, nämlich /**. Dies ist formal für die Sprache nur ein /* Kommentar, dient aber verschiedenen Tools als Erkennung für einen Dokumentationskommentar:
/**
  main Funktion des Hello World Programms
  @author Jens Weller
  @version 1.1
  */


Hier können verschiedene Angaben zur Dokumentation gemacht werden, zeilen mit @bezeichner werden erkannt, und zum Beispiel von doxygen dann entsprechend in einer Dokumentation ausgeben.
Als kleinen Trick noch die Erwähnung von //*/, dies ist ein auskommentiertes Kommentarende. Gerade wenn Codeblöcke auskommentiert werden, ist dies sehr nützlich. Warum? Wenn man den Kommentaranfang löscht (/*), bleibt das Ende gültig im Code zurück, der Codeblock lässt sich also wieder leicht auskommentieren. Auch vergisst man gerne das löschen des Kommentarendes, welches dann zu einem Fehler im Build führt.