Beispiel für das Hinzufügen von Kommentaren in 15 Programmiersprachen

Lassen Sie uns herausfinden, was Kommentare sind und warum sie in der Programmierung wichtig sind

Wir behandeln auch zwei gängige Arten von Kommentaren und wie man sie in 15 verschiedenen Programmiersprachen schreibt

Was sind Kommentare in der Programmierung?

Kommentare sind, laienhaft ausgedrückt, Textstücke, die für den Endbenutzer nicht sichtbar sind und als Referenz für die Personen dienen, die den Code schreiben

Etwas formeller ausgedrückt: Ein Kommentar ist eine Beschreibung eines Programms, wie es funktioniert, in einem einfach lesbaren Format. Sie werden in der Regel an Stellen verwendet, die dem Entwickler, der den Code liest, zusätzliche Klarheit verschaffen sollen. Dadurch wird die Lesbarkeit des Codes verbessert und der Zeit- und Kommunikationsaufwand für den Wissenstransfer reduziert

Der Compiler/Interpreter ignoriert die Kommentare in Ihrem Code einfach und hat somit keinen Einfluss auf die Endausgabe Ihres Programms. Kurz gesagt sind Kommentare also wie eine einfach zu lesende Erklärung für bestimmte Codeteile

Übliche Arten von Kommentaren

Die meisten Programmiersprachen unterstützen 2 Arten von Kommentaren

• Einzeiliger Kommentar
• Mehrzeiliger Kommentar / Blockkommentar

Wie der Name schon sagt, sind einzeilige Kommentare nützlich, wenn man einen kleinen einzeiligen Text hinzufügen möchte, z.B. eine bestimmte Bedingung, einen konstanten Wert, der eine kleine Beschreibung benötigt. Mehrzeilige Kommentare hingegen sind besser geeignet, wenn eine größere Menge an Informationen hinzugefügt werden soll, z.B. eine Beschreibung einer Funktion und wie sie verwendet werden kann usw

Es gibt noch einige andere Arten von Kommentaren, wie z.B. Dokumentenkommentare, aber das würde den Rahmen dieses Artikels sprengen

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 größte Vorteil des Hinzufügens von Kommentaren ist die bessere Lesbarkeit und das bessere Verständnis des Programms. Abgesehen davon gibt es noch weitere Vorteile

• Kommentare machen es Ihren Kollegen und sogar anderen Entwicklern sehr leicht, die Logik zu verstehen, ohne lange Dokumentationen lesen zu müssen.
• Reduzierte Kommunikation zwischen Entwicklern bei kleinen Zweifeln
• Kommentare werden von den Compilern/Interpretern ignoriert.
• Für Open-Source-Software sind sie ein Muss, da Sie nicht da sein werden, um Millionen von Entwicklern, die dieses bestimmte Programm verwenden wollen, jede Funktion zu erklären.

Kommentare in mehreren Sprachen

Toll, jetzt haben wir gelernt, was Kommentare sind und warum sie nützlich sind. Sehen wir uns an, wie wir in verschiedenen Programmiersprachen Kommentare einfügen können

Kommentare in C/C

Einzeiliger Kommentar

// Dies ist ein einzeiliger Kommentar in C/C 

Mehrzeiliger Kommentar

/* Dies ist ein etwas langer
mehrzeiliger Kommentar in C/C */

Kommentare in Python

Einzeiliger Kommentar

# Dies ist ein einzeiliger Kommentar in Python

Mehrzeiliger Kommentar

# Dies ist ein etwas langer

#

 mehrzeiliger Kommentar

in Python

Kommentare in Java

Einzeiliger Kommentar

// Dies ist ein einzeiliger Kommentar in Java

Mehrzeiliger Kommentar

/* Dies ist ein etwas langer
mehrzeiliger Kommentar in Java */

Kommentare in Ruby

Einzeiliger Kommentar

# Dies ist ein einzeiliger Kommentar in Ruby

Mehrzeiliger Kommentar

=begin
Dies ist ein etwas langer
mehrzeiliger Kommentar in Ruby

=end

Kommentare in Golang

Einzeiliger Kommentar

// Dies ist ein einzeiliger Kommentar in Golang

Mehrzeiliger Kommentar

/* Dies ist ein etwas langer
mehrzeiliger Kommentar in Golang */

Kommentare in Haskell

Einzeiliger Kommentar

- Dies ist ein einzeiliger Kommentar in Haskell

Mehrzeiliger Kommentar

{- Dies ist ein etwas langer
mehrzeiliger Kommentar in Haskell -}

Kommentare in Rust

Einzeiliger Kommentar

// Dies ist ein einzeiliger Kommentar in Rust

Mehrzeiliger Kommentar

/* Dies ist ein etwas langer
mehrzeiliger Kommentar in Rust */

Kommentare in HTML

Einzeiliger Kommentar

Mehrzeiliger Kommentar

Kommentare in CSS

Einzeiliger Kommentar

/* Dies ist ein einzeiliger Kommentar in CSS */

Mehrzeiliger Kommentar

/* Dies ist ein etwas langer
mehrzeiliger Kommentar in CSS */

Kommentare in JavaScript

Einzeiliger Kommentar

// Dies ist ein einzeiliger Kommentar in Javascript

Mehrzeiliger Kommentar

/* Dies ist ein etwas langer
mehrzeiliger Kommentar in Javascript */

Kommentare in R

Einzeiliger Kommentar

# Dies ist ein einzeiliger Kommentar in der Programmiersprache R

Mehrzeiliger Kommentar

R unterstützt keine mehrzeiligen Kommentare

Kommentare in Erlang

Einzeiliger Kommentar

% Dies ist ein einzeiliger Kommentar in Erlang

Mehrzeiliger Kommentar

R unterstützt keine mehrzeiligen Kommentare

Kommentare in PHP

Einzeiliger Kommentar

// Dies ist ein einzeiliger Kommentar in PHP

Mehrzeiliger Kommentar

/* Dies ist ein etwas langer
mehrzeiliger Kommentar in PHP */

Kommentare in Perl

Einzeiliger Kommentar

# Dies ist ein einzeiliger Kommentar in Perl

Mehrzeiliger Kommentar

=begin
Dies ist ein etwas langer
mehrzeiliger Kommentar in Perl

=end

Kommentare in Kotlin

Einzeiliger Kommentar

// Dies ist ein einzeiliger Kommentar in Kotlin

Mehrzeiliger Kommentar

/* Dies ist ein etwas langer
mehrzeiliger Kommentar in Kotlin */

Fazit

Das Tutorial behandelte die Grundlagen von Kommentaren und 2 gängige Typen – einzeilige und mehrzeilige. Ich habe auch versucht zu erklären, warum Kommentare nützlich sind und warum man sie bei Bedarf schreiben sollte. Ich hoffe, Sie haben etwas Neues gelernt!

Erforschen Sie weiter. Lernen Sie weiter! 👨‍💻