Kommentar (Programmierung)

Kommentare sind Annotationen innerhalb von Programmiersprachen und Textbeschreibungssprachen. Alle diese Sprachen bestehen aus Anweisungen für den Computer (Code) und Hinweisen für Textbearbeiter (Kommentaren). Wird ein Quelltext weiterverarbeitet (kompiliert, interpretiert, geparst etc.), dann werden Kommentare von der verarbeitenden Software ignoriert und haben daher keinen Einfluss auf das Ergebnis. Der Nutzer bzw. Betrachter des Ergebnisses kann daher auch nicht mehr auf die Existenz der Kommentare rückschließen.

Vereinzelt werden Kommentare allerdings auch zur Speicherung maschinenlesbarer Metainformationen oder zur Ergänzung einer Sprache genutzt (siehe Ausnahmen).

Syntax allgemein

Für eine Sprache ist festgelegt, wo ein Kommentar beginnt und wo er endet. Man unterscheidet allgemein zwischen Block- und Zeilenkommentaren. Zeilenkommentare enden automatisch am Zeilenende. Blockkommentare können sich über mehrere Zeilen erstrecken und enden nach der Einleitung erst bei dem Endzeichen. In manchen Sprachen sind Blockkommentare auch innerhalb eines einzelnen Code-Befehls erlaubt. Dies wird jedoch selten genutzt.

Der Inhalt eines Kommentars und somit auch sein Nutzen kann vom Bearbeiter frei gewählt werden und unterliegt keiner verbindlichen Syntax, außer dass bei Blockkommentaren die Kommentar-Endmarkierung im Kommentar selbst nicht enthalten sein darf. In der Regel werden Kommentare in „menschlicher“ Sprache festgehalten, entweder in der Muttersprache des Autors oder in einer Allerweltssprache. Kommentare bestehen meist nur aus Text (d. h. keine Formatierungen, Grafiken, Klänge, etc.), da die meisten Sprachen nur solche Kommentare zulassen.

Verwendung

Trotz der freien Verwendbarkeit werden Kommentare besonders oft in folgender Weise verwendet:

Informationen über den gesamten Quelltext

Zu Beginn eines Quelltextes kann der Autor Vorbemerkungen zu selbigem anbringen, darunter Angabe des Autors, der Lizenz, des Erstellungsdatums, Kontaktadresse bei Fragen, Liste anderer benötigter Dateien, einen Gruß an Programmierkollegen, etc.

Gliederung des Quelltextes

Überschriften und Abschnitte können als solche gekennzeichnet werden. Dabei werden häufig nicht nur sprachliche Mittel verwendet („Hier beginnt der residente Teil“) sondern auch grafische Mittel, die sich durch Text umsetzen lassen („****=- Residenter Teil -=****“)

Erläuterung einer einzelnen Zeile

So kann die Arbeitsweise oder Bedeutung eines Textteils (z. B. Programmzeile, Tag) erläutert werden, damit andere oder der Autor selbst diese später leichter verstehen.

Hinweis auf zu erledigende Arbeit

Kommentare können unzureichende Codestücke kennzeichnen („Hier muss noch die Unterstützung von Umlauten verbessert werden“) oder Platzhalter für komplett fehlende Codestücke sein („Hier Tabellendarstellung einfügen“).

Auskommentierung

Soll ein Bestandteil des Codes vorübergehend gelöscht, jedoch eventuell später wieder eingesetzt werden, so wird er auskommentiert. Das Codestück ist, sobald es im Kommentar verpackt ist, aus Sicht des Compilers kein Code mehr, d. h. es ist praktisch nicht mehr vorhanden.

Ausnahmen: Verwendung entgegen der Definition

Ausnahmen von der obigen Definition von Kommentaren (Kommentare, die vom Computer nicht immer ignoriert werden) sind unter anderem:

Präprozessor

Sprachen, die keine eigene Syntax für Präprozessoranweisungen haben, verwenden spezielle Kommentare. Im ersten Durchlauf ermittelt der Präprozessor aus den Kommentaren die nötigen Informationen, im zweiten Durchlauf (Compilen, Interpretieren, etc.) werden diese Kommentare dann (wie alle Kommentare) überlesen.

Einbettung von Fremdsprachen

In Quelltexten, die sich aus mehreren Sprachen zusammensetzen, wird eine Sprache in die Kommentare der anderen eingebettet. Das wohl bekannteste Beispiel sind Javascripts, die sich in HTML-Kommentaren verbergen. Dies ist meistens nur eine Übergangslösung, um mit älteren Programmen kompatibel zu bleiben, welche die eingebettete Sprache nicht verstehen würden und sie daher als Fehler betrachten würden.

Automatisierte Codeerstellung

Wird Code mit einer Entwicklungsumgebung erstellt (z. B. HTML-Editor), so kann diese Informationen in Kommentaren speichern, die für sie von Belang sind, für den Weiterverarbeiter des Codes (z. B. Browser) jedoch keinen Sinn haben.

Automatisierte Sourcecode-Dokumentation

Für einige Programmiersprachen existieren Hilfsprogramme, die spezielle Kommentare aus dem Quellcode extrahieren können und mithilfe einer Analyse des eigentlichen Programmcodes automatisch Softwaredokumentation generieren können. Werkzeuge dafür sind zum Beispiel Javadoc oder Doxygen.

Codegenerierung

Dabei wird durch spezielle Kommentare ermöglicht, im Quellcode Instruktionen für verschiedene Werkzeuge abzulegen. Ein Beispiel dafür ist XDoclet. Dabei werden sogenannte Annotationen durch einen eigenen Verarbeitungslauf verarbeitet und aus dem Quelltext neben dem eigentlichen Programm auch weiteren Dateien erzeugt.

Syntax am Beispiel einiger Sprachen

Die Syntax von Kommentaren ist in den verschiedenen Sprachen unterschiedlich. Hier einige Beispiele:

Sprache	Variante	Syntax
FORTRAN	Zeilenkommentar	C ein Kommentar bis zum Zeilenende * ein Kommentar bis zum Zeilenende Code ! So kann man auch mitten in einer Zeile kommentieren
C, C++, C#, JavaScript, PHP, Java, CSS, SQL	Blockkommentar	Code /* Ein Kommentar, der auch Zeilenumbrüche enthalten darf. */ Code
C, C++, C#, JavaScript, PHP, Java	Blockkommentar	$x = 5 * (2 + /* Ein Kommentar innerhalb einer Anweisung */ 3);
Pascal, Modula-2, Oberon, Seed7	Blockkommentar	Code (* Ein Kommentar, mit Zeilenumbrüchen *) Code
Pascal	Blockkommentar	Code { Ein Kommentar, mit Zeilenumbrüchen } Code
C++, C#, Delphi, Pascal, JavaScript, PHP, Java, Bourne-Shell, PowerFlex, Scilab	Zeilenkommentar	Code // Kommentar, der bis zum Zeilenende geht // Soll er weitergehen, muss er erneut als Kommentar // gekennzeichnet werden.
Shell-Skript, Perl, Python, Ruby, PHP (selten), Windows PowerShell, Seed7	Zeilenkommentar	Code # ein Kommentar bis zum Zeilenende
Assembler, Lisp, INI-Datei	Zeilenkommentar	Code ; Kommentar bis zum Zeilenende
BASIC, Batch (cmd.exe, ...)	Zeilenkommentar	REM Kommentar bis zum Zeilenende
BASIC, Visual Basic	Zeilenkommentar	Code ' Kommentar bis zum Zeilenende
XML (z. B. XHTML), HTML, MediaWiki	Blockkommentar	Code <!-- Kommentar zwischen SGML-Tags --> Code
Ada, AppleScript, SQL, Haskell, VHDL	Zeilenkommentar	Code -- ein Kommentar bis zum Zeilenende
Erlang, LaTeX, MATLAB, TeX	Zeilenkommentar	Code  % ein Kommentar bis zum Zeilenende
MATLAB	Blockkommentar (ab Version 7.x)	Code %{ Ein Kommentar, der auch Zeilenumbrüche enthalten darf. %} Code
ABAP	Zeilenkommentar	Code " ein Kommentar bis zum Zeilenende
		Code * ein Kommentar bis zum Zeilenende * ein Kommentar bis zum Zeilenende Code
M4	Zeilenkommentar	Code dnl ein Kommentar bis zum Zeilenende
LaTeX	Blockkommentar (Nur mit zusätzlichen Paketen wie "verbatim" oder "comment")	Code \begin{comment} Ein Kommentar, mit Zeilenumbrüchen \end{comment} Code
Mathematica	Blockkommentar	Code (* Ein Kommentar, der auch Zeilenumbrüche enthalten darf. *) Code
Haskell	Blockkommentar (geschachtelt)	Code {- Ein Kommentar, mit Zeilenumbrüchen und einem geschachtelten Kommentar: {- Ich bin der innere Kommentar und nur ich werde durch die folgende Zeichenkombination geschlossen: -} , der durch die folgende Zeichenkombination geschlossen wird: -} Code