Was ist ein Quelltext-Kommentar?

Ein Quelltext-Kommentar ist ein erklärender Hinweis, der direkt im Programmcode eingefügt wird, den Rechner oder die Browser aber beim Ausführen des Codes ignorieren. Kommentare dienen dazu, für Menschen nachvollziehbar zu machen, was bestimmte Abschnitte des Codes bewirken, warum eine spezielle Lösung gewählt wurde oder welche offenen Aufgaben noch bestehen. Sie fördern die Verständlichkeit und Wartbarkeit eines Projekts – besonders wenn mehrere Entwickler zusammenarbeiten oder nach einer längeren Zeit jemand anders (oder man selbst) den Code wieder liest.

Kommentare können auch genutzt werden, um temporären Code zu „deaktivieren“, ohne ihn löschen zu müssen. Je nach Programmiersprache gibt es verschiedene Schreibweisen: In HTML nutzt man beispielsweise , in JavaScript // Kommentar oder /* … */, in Python # Kommentar.

Gute Quelltext-Kommentare erleichtern die Zusammenarbeit und beugen Fehlern oder Missverständnissen vor. Allerdings sollten sie sinnvoll eingesetzt werden – zu viele oder zu oberflächliche Kommentare können unübersichtlich wirken. Der beste Code erklärt sich meist weitgehend selbst, aber an komplexeren Stellen sind Kommentare unverzichtbar.