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 (Compiliert, Interpretiert, Geparst etc.) 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 ).

Syntax allgemein

Für eine Sprache ist festgelegt, wo ein Kommentar beginnt und wo er endet. Man unterscheidet allgemein zwischen Block- und Zeilenkommentaren. Blockkommentare können sich über mehrere Zeilen erstrecken und enden nach der Einleitung erst bei dem Endzeichen. Zeilenkommentare enden automatisch am Zeilenende.

Der Inhalt eines Kommentars und somit auch sein Nutzen kann vom Bearbeiter frei gewählt werden und unterliegt keiner verbindlichen Syntax, außer dass die 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 versteht.

;Hinweis auf zu erledigende Arbeit:Kommentare können unzureichende Codestücke kennzeichnen ("Hier muss noch die Unterstüztung 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. er 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, die die eingebettete Sprache nicht verstehen würden und sie daher als Fehler anerkennen würden.

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

Syntax am Beispiel einiger Sprachen

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

| Sprache
| Variante
| Syntax

 | C, C++, C#, JS
| Blockkommentar
| Code/* Ein Kommentar, 
der auch Zeilenumbrüche
 enthalten darf. */Code
 | C++, C#, JS,
Bourne Shell,
Lisp,PowerFlex
| Zeilenkommentar
| Code// Kommentar, der bis zum Zeilenende geht
// Soll er weitergehen, muss er erneut als Kommentar
// gekennzeichnet werden.
 | Basic bzw. Batch
| REM-Kommentar
| Kommentarzeile, die mit dem Befehl REM eingeleitet wird.

 | Basic
| Apostroph-Kommentar
| Code ' Kommentar bis zum Zeilenende

 | HTML
| Kommentar mit SGML-Tags
| CodeCode

Diese Liste ließe sich für verschiedene Sprachen beliebig weiterführen. Man sieht jedoch schon, dass die Verwendung von Kommentaren prinzipiell in allen Sprachen sehr ähnlich abläuft.

Help build the largest human-edited directory on the web.

Submit a Site - Open Directory Project - Become an Editor