Blockkommentar

Blockkommentar bezeichnet in der Programmierung eine Form des Kommentars, der mehrere Zeilen umfasst. Der Inhalt wird vom Compiler oder Interpreter ignoriert und dient der Erklärung, Dokumentation oder der zeitweiligen Deaktivierung von Code. Im Gegensatz zu einzeiligen Kommentaren erstreckt sich ein Blockkommentar über mehrere Zeilen.

In vielen Sprachen erfolgt die Kennzeichnung von Blockkommentaren durch spezielle Paare von Symbolen. Häufig verwendet sind /* ... */ in C, C++, Java, JavaScript, C# und verwandten Sprachen. HTML und XML nutzen <!-- ... --> als mehrzeilige Kommentarblöcke. SQL unterstützt Blockkommentare ebenfalls meist in der Form /* ... */; einige Dialekte nutzen zusätzlich andere Konstrukte. Ruby kennt die mehrzeilige Kommentarkonstruktion =begin ... =end. Python besitzt keine offizielle Blockkommentarsyntax; stattdessen werden oft dreifache Anführungszeichen als Docstrings verwendet, die zwar Strings sind, aber in der Praxis als mehrzeilige Kommentare dienen. In Shell-Skripten existiert kein standardisiertes Blockkommentar-Werkzeug; gängige Techniken verwenden hier eine Here-Document-Konstruktion mit einem No-Op-Befehl, z. B. : <<'COMMENT' ... COMMENT.

Best practices berücksichtigen die unterschiedlichen Regeln der Sprachen. Blockkommentare eignen sich gut für längere Erklärungen, das Dokumentieren von API-Schnittstellen oder das temporäre Deaktivieren größerer Codeblöcke während der Fehleranalyse. Sie sollten klar und sinnvoll formuliert sein, relevant zum Kontext bleiben und nicht offensichtlich aus dem Code abzuleiten sein. Die Kommentarart kann auch für Dokumentationszwecke genutzt werden, etwa in Sprachen, die speziell Doc-Comments unterstützen (beispielsweise Javadoc oder Doxygen, die mit bestimmten Blockkommentaren arbeiten). Regelmäßige Pflege der Kommentare ist wichtig, um Konsistenz mit dem Code zu wahren.