Blockkommentarsyntax

Blockkommentarsyntax bezeichnet eine Form des Kommentars in Programmiersprachen, bei der der Kommentar mit einem Eröffnungs- und einem Schließzeichen eingeschlossen wird und über mehrere Zeilen reichen kann. Im Gegensatz zu einzeiligen Kommentaren, die am Zeilenende beginnen, dient Blockkommentarsyntax der Dokumentation längerer Sachverhalte oder dem temporären Ausschalten von Code.

Häufig verwendet werden Delimiter aus der C-Familie: / und /. Sprachen wie C, C++, Java, JavaScript, C#, CSS und SQL nutzen diese Blockkommentartechnik. HTML und XML verwenden eigene Blockkommentare: <!-- und -->. In einigen Sprachen lässt sich Blockkommentar verschachteln (beispielsweise OCaml) während andere Sprachen keine Verschachtelung unterstützen, weil der innere Terminator das Ende des äußeren Kommentars markiert.

Verwendung: Blockkommentare dienen zur Dokumentation von Funktionen, Klassen oder Modulen, zum Ausschalten größerer Codeblöcke während der Entwicklung und zum Einfügen längerer Erklärungen, die in eine Zeile nicht passen. Gute Praxis ist, Blockkommentare präzise zu formulieren, aktuell zu halten und sie sinnvoll dort einzusetzen, wo sie den Code verständlicher machen.

Begrenzungen: Da die Syntax je Sprache variiert, können Fehler beim Öffnen oder Schließen der Delimiter auftreten; verschachtelte Blockkommentare sind in vielen Sprachen problematisch oder nicht vorgesehen. Entwickler sollten die spezifische Spezifikation der jeweiligen Sprache beachten.