Lasst uns gemeinsam erkunden, was Code-Kommentare sind und welche Bedeutung sie in der Programmierung haben.
Wir werden uns auch mit zwei gängigen Arten von Kommentaren beschäftigen und zeigen, wie man sie in 15 unterschiedlichen Programmiersprachen verwendet.
Was sind Kommentare im Programmcode?
In einfachen Worten sind Kommentare Textpassagen, die für den Endnutzer nicht sichtbar sind. Sie dienen als Orientierungshilfe für diejenigen, die den Code schreiben.
Etwas formeller ausgedrückt ist ein Kommentar eine Erläuterung eines Programms, die in einer leicht verständlichen Form darlegt, wie es funktioniert. Solche Kommentare werden meistens dort eingesetzt, wo der Entwickler, der den Code durchgeht, zusätzliche Erklärungen benötigt. Dadurch wird die Lesbarkeit des Codes erhöht und der Zeitaufwand sowie die Kommunikation, die für die Wissensvermittlung nötig wären, reduziert.
Der Compiler oder Interpreter ignoriert die Kommentare im Code vollständig, sodass sie keinen Einfluss auf das Endergebnis des Programms haben. Kurz gesagt, Kommentare sind wie leicht verständliche Erklärungen für bestimmte Codeabschnitte.
Übliche Arten von Kommentaren
Die meisten Programmiersprachen unterstützen zwei Haupttypen von Kommentaren:
- Einzeilige Kommentare
- Mehrzeilige Kommentare / Blockkommentare
Wie der Name schon sagt, sind einzeilige Kommentare besonders nützlich, wenn man kurze, einzeilige Textinformationen hinzufügen möchte, z. B. zu einem spezifischen Zustand oder einem konstanten Wert, der einer kurzen Beschreibung bedarf. Mehrzeilige Kommentare hingegen eignen sich besser, wenn eine größere Menge an Informationen benötigt wird, wie etwa eine detailliertere Beschreibung einer Funktion und ihrer Verwendung.
Es gibt auch andere Kommentararten, wie z. B. Dokumentationskommentare, aber diese gehen über den Rahmen dieses Artikels hinaus.
Warum Kommentare hinzufügen?
„Jeder Programmierer kann Code schreiben, den ein Computer versteht. Gute Programmierer schreiben Code, den Menschen verstehen können.“ – Martin Fowler
Der Hauptnutzen von Kommentaren ist die verbesserte Lesbarkeit und das tiefere Verständnis des Programms. Daneben gibt es weitere Vorteile:
- Kommentare erleichtern es Kollegen und anderen Entwicklern erheblich, die Logik des Codes zu verstehen, ohne sich durch umfangreiche Dokumentationen arbeiten zu müssen.
- Sie reduzieren die Kommunikationsnotwendigkeit zwischen Entwicklern bei kleineren Unklarheiten.
- Kommentare werden vom Compiler oder Interpreter nicht beachtet.
- In Open-Source-Projekten sind sie unerlässlich, da man nicht jeder der potentiell Millionen von Entwicklern, die das Programm verwenden möchten, jede Funktion einzeln erklären muss.
Kommentare in verschiedenen Sprachen
Nun, da wir etwas über Kommentare und ihre Nützlichkeit gelernt haben, wollen wir untersuchen, wie man Kommentare in unterschiedlichen Programmiersprachen einfügt.
Einzeiliger Kommentar
// Dies ist ein einzeiliger Kommentar in C/C++
Mehrzeiliger Kommentar
/* Dies ist ein etwas längerer mehrzeiliger Kommentar in C/C++ */
Einzeiliger Kommentar
# Dies ist ein einzeiliger Kommentar in Python
Mehrzeiliger Kommentar
# Dies ist ein etwas längerer # mehrzeiliger Kommentar in Python
Einzeiliger Kommentar
// Dies ist ein einzeiliger Kommentar in Java
Mehrzeiliger Kommentar
/* Dies ist ein etwas längerer mehrzeiliger Kommentar in Java */
Einzeiliger Kommentar
# Dies ist ein einzeiliger Kommentar in Ruby
Mehrzeiliger Kommentar
=begin Dies ist ein etwas längerer mehrzeiliger Kommentar in Ruby =end
Einzeiliger Kommentar
// Dies ist ein einzeiliger Kommentar in Golang
Mehrzeiliger Kommentar
/* Dies ist ein etwas längerer mehrzeiliger Kommentar in Golang */
Einzeiliger Kommentar
-- Dies ist ein einzeiliger Kommentar in Haskell
Mehrzeiliger Kommentar
{- Dies ist ein etwas längerer
mehrzeiliger Kommentar in Haskell -}
Einzeiliger Kommentar
// Dies ist ein einzeiliger Kommentar in Rust
Mehrzeiliger Kommentar
/* Dies ist ein etwas längerer mehrzeiliger Kommentar in Rust */
Einzeiliger Kommentar
<!-- Dies ist ein einzeiliger Kommentar in HTML -->
Mehrzeiliger Kommentar
<!-- Dies ist ein etwas längerer mehrzeiliger Kommentar in HTML -->
Einzeiliger Kommentar
/* Dies ist ein einzeiliger Kommentar in CSS */
Mehrzeiliger Kommentar
/* Dies ist ein etwas längerer mehrzeiliger Kommentar in CSS */
Einzeiliger Kommentar
// Dies ist ein einzeiliger Kommentar in Javascript
Mehrzeiliger Kommentar
/* Dies ist ein etwas längerer mehrzeiliger Kommentar in Javascript */
Einzeiliger Kommentar
# Dies ist ein einzeiliger Kommentar in der Programmiersprache R
Mehrzeiliger Kommentar
R unterstützt keine mehrzeiligen Kommentare.
Einzeiliger Kommentar
% Dies ist ein einzeiliger Kommentar in Erlang
Mehrzeiliger Kommentar
Erlang unterstützt keine mehrzeiligen Kommentare.
Einzeiliger Kommentar
// Dies ist ein einzeiliger Kommentar in PHP
Mehrzeiliger Kommentar
/* Dies ist ein etwas längerer mehrzeiliger Kommentar in PHP */
Einzeiliger Kommentar
# Dies ist ein einzeiliger Kommentar in Perl
Mehrzeiliger Kommentar
=begin Dies ist ein etwas längerer mehrzeiliger Kommentar in Perl =end
Einzeiliger Kommentar
// Dies ist ein einzeiliger Kommentar in Kotlin
Mehrzeiliger Kommentar
/* Dies ist ein etwas längerer mehrzeiliger Kommentar in Kotlin */
Fazit
Diese Einführung hat die Grundlagen der Kommentare und zwei gängige Typen – einzeilige und mehrzeilige Kommentare – behandelt. Es wurde zudem erläutert, warum Kommentare nützlich sind und man sie bei Bedarf setzen sollte. Ich hoffe, Sie haben etwas Neues gelernt!
Erforschen Sie weiter. Lernen Sie weiter! 👨💻