Lassen Sie uns herausfinden, was Kommentare sind und warum sie beim Programmieren wichtig sind.
Wir behandeln auch zwei gängige Arten von Kommentaren und wie man sie in 15 verschiedenen Programmiersprachen schreibt.
Inhaltsverzeichnis
Was sind Kommentare in der Programmierung?
Kommentare in Laiensprache sind Textstücke, die für Endbenutzer nicht sichtbar sind und als Referenz für Personen dienen, die Code schreiben.
Ein bisschen formeller ist ein Kommentar eine Beschreibung eines Programms darüber, wie es in einem einfach lesbaren Format funktioniert. Diese werden normalerweise an Stellen verwendet, an denen dem Entwickler, der den Code durchliest, zusätzliche Klarheit geboten werden muss. Somit trägt dies zur Verbesserung der Lesbarkeit des Codes bei und reduziert Zeit und Kommunikation, die zum Übertragen von Wissen erforderlich wären.
Der Compiler/Interpreter ignoriert einfach die Kommentare in Ihrem Code und wirkt sich dadurch nicht auf die Endausgabe Ihres Programms aus. Kurz gesagt, Kommentare sind wie eine einfache lesbare Erklärung für bestimmte Codeteile.
Gängige Arten von Kommentaren
Die meisten Programmiersprachen unterstützen zwei Arten von Kommentaren.
- Einzeiliger Kommentar
- Mehrzeiliger Kommentar / Blockkommentare
Wie der Name schon sagt, sind einzeilige Kommentare nützlich, wenn man kleinen einzeiligen Text hinzufügen muss, z. ein bestimmter Zustand, ein konstanter Wert, der einer kleinen Beschreibung bedarf. Wohingegen Mehrzeilen besser funktionieren, wenn wir eine größere Menge an Informationen hinzufügen müssen, wie eine Beschreibung einer Funktion und wie man sie verwenden kann usw.
Es gibt einige andere Arten von Kommentaren wie Dokumentkommentare, aber das geht über den Rahmen dieses Artikels hinaus.
Warum sollten Sie Kommentare hinzufügen?
„Jeder Dummkopf kann Code schreiben, den ein Computer verstehen kann. Gute Programmierer schreiben Code, den Menschen verstehen können.“ – Martin Fowler
Der Hauptvorteil des Hinzufügens von Kommentaren ist die verbesserte Lesbarkeit und das bessere Verständnis des Programms. Abgesehen davon sind einige weitere Vorteile:
- Kommentare machen es Ihren Kollegen und sogar anderen Entwicklern super einfach, die Logik zu verstehen, ohne sich lange Dokumentationen durchlesen zu müssen.
- Reduzierte Kommunikation zwischen Entwicklern für kleine Zweifel
- Kommentare werden vom Compiler/Interpreter ignoriert.
- Für Open-Source-Software sind diese ein Muss, da Sie Millionen von Entwicklern, die dieses bestimmte Programm verwenden möchten, nicht jede Funktion erklären müssen.
Kommentare in mehreren Sprachen
Großartig, jetzt, wo wir etwas über Kommentare gelernt haben und warum sie nützlich sind. Lassen Sie uns untersuchen, wie wir Kommentare in verschiedenen Programmiersprachen hinzufügen können.
Einzeiliger Kommentar
// This is a single line comment in C/C++
Mehrzeiliger Kommentar
/* This is slightly long multi line comment in C/C++ */
Einzeiliger Kommentar
# This is a single line comment in Python
Mehrzeiliger Kommentar
# This is slightly long # multi line comment in Python
Einzeiliger Kommentar
// This is a single line comment in Java
Mehrzeiliger Kommentar
/* This is slightly long multi line comment in Java */
Einzeiliger Kommentar
# This is a single line comment in Ruby
Mehrzeiliger Kommentar
=begin This is slightly long multi line comment in Ruby =end
Einzeiliger Kommentar
// This is a single line comment in Golang
Mehrzeiliger Kommentar
/* This is slightly long multi line comment in Golang */
Einzeiliger Kommentar
– – This is a single line comment in Haskell
Mehrzeiliger Kommentar
{- This is slightly long
multi line comment in Haskell -}
Einzeiliger Kommentar
// This is a single line comment in Rust
Mehrzeiliger Kommentar
/* This is slightly long multi line comment in Rust */
Einzeiliger Kommentar
<!-- This is a single line comment in HTML -->
Mehrzeiliger Kommentar
<!-- This is slightly long multi line comment in HTML -->
Einzeiliger Kommentar
/* This is a single line comment in CSS */
Mehrzeiliger Kommentar
/* This is slightly long multi line comment in CSS */
Einzeiliger Kommentar
// This is a single line comment in Javascript
Mehrzeiliger Kommentar
/* This is slightly long multi line comment in Javascript */
Einzeiliger Kommentar
# This is a single line comment in R programming language
Mehrzeiliger Kommentar
R unterstützt keine mehrzeiligen Kommentare.
Einzeiliger Kommentar
% This is a single line comment in Erlang
Mehrzeiliger Kommentar
R unterstützt keine mehrzeiligen Kommentare.
Einzeiliger Kommentar
// This is a single line comment in PHP
Mehrzeiliger Kommentar
/* This is slightly long multi line comment in PHP */
Einzeiliger Kommentar
# This is a single line comment in Perl
Mehrzeiliger Kommentar
=begin This is slightly long multi line comment in Perl =end
Einzeiliger Kommentar
// This is a single line comment in Kotlin
Mehrzeiliger Kommentar
/* This is slightly long multi line comment in Kotlin */
Fazit
Das Tutorial behandelte die Grundlagen zu Kommentaren und 2 gängige Typen – Single und Multi-line. Ich habe auch versucht zu erläutern, warum Kommentare nützlich sind und man sie bei Bedarf schreiben sollte. Ich hoffe, Sie haben etwas Neues gelernt!
Erkunden Sie weiter. Lerne weiter! 👨💻