Ein Kommentar ist ein Teil des Quelltextes, der vom Compiler nicht
verarbeitet wird. Er dient einzig und allein der besseren Lesbarkeit
des Programmtextes. In C++ können Kommentare entweder einzeilig
(ab //
) oder mehrzeilig (von /*
bis */
)
sein. Die Bedeutung von Kommentaren wird häufig unterschätzt.
Bei Änderungen oder Wiederverwertungen von vorhandenen
Quelltexten ist es häufig extrem schwierig, Programmabläufe
nachzuvollziehen, wenn sie nicht ausreichend kommentiert sind. Dies
gilt sowohl für Menschen, die diesen zum ersten Mal sehen, als
auch oft für den Autor selber, wenn er zeitlichen Abstand zu
seinem Programm gewonnen hat.
Kommentare sollten zum einen die Wirkung von Programmteilen beschreiben, aber nicht zuletzt auch Annahmen, die gemacht wurden, damit Teile des Programms laufen. Falls man bei einer Funktion, Schleife oder einem anderen Programmteil davon ausgeht, daß z.B. der Wert einer Variablen in einem gewissen Bereich liegt, dann sollte man dies unbedingt im Quelltext kommentieren, da diese Annahmen sonst leicht verloren gehen.