Skip to main content

Warum Java Kommentare immer ein Mittel der Kommunikation sind

Kennst Du die Bücherreihe „Miteinander reden“ von Schulz von Thun?

Falls Du an der Uni warst oder bist, gehört dieses Buch zur Standardlektüre im Fach Schlüsselkompetenz.

Denn ein Java Entwickler, welcher im Team arbeitet, muss klar und deutlich kommunizieren können.

Und klar und deutlich heißt nicht, dass die Aussprache Deiner Worte verständlich sein soll.

Nein hier geht es darum, dass Informationsverluste gar nicht oder nur im geringem Maße auftreten.

Denn eine Kommunikation ist immer eine Schnittstelle.

Was heißt das?
Ein Absender versendet eine Information und ein Empfänger empfängt diese.
Und zwischen beiden Übergängen befindet sich ein Bereich.
Eine Schnittstelle oder Schnittbereich zwischen Absender und Empfänger.

Und beim Übergang einer Information vom Absender auf den Empfänger, entstehen immer Informationsverluste oder -verfälschungen.

Der Absender sendet eine Information.
Und der Empfänger übersetzt diese Information dann für sich.
Und dabei entsteht sehr viel Interpretationsspielraum.

Das tolle an einer Programmiersprache ist, dass dieser Interpretationsspielraum nicht gegeben ist.

Dennoch haben wir Informationsverluste und zwar auch im Code.

Wodurch diese Informationsverluste entstehen und wie du das Problem umgehen solltest, das möchte ich Dir in diesem Artikel zeigen.

Was ich meine, wenn ich von Informationsverlusten im Code schreibe.

Angenommen Du arbeitest allein und programmierst.

Später dann, schaust Du Dir Deinen Code an.

Kannst Du ihn lesen?
Wenn ja alles super.

Aber was wäre, wenn zwischen dem Zeitpunkt der Programmierung und deinem späteren Regress ein Monat, ein Jahr oder ein Jahrzehnt liegen würde?

Wir müssen als Java Programmierer immer sehen, dass wir uns ständig weiter entwickeln. Und wenn Du Deinen Code heute schreibst und in einem Monat liest, liegt zwischen diesen Zeitpunkten nicht nur Zeit – Es liegt auch Erfahrung dazwischen.

Du schaust Deinen Code durch eine andere Erfahrungsstufe, eine andere Weitsicht an.

Man kann fast sagen, es schaut ein anderer Mensch auf diesen Code.
Und jetzt haben wir eine Schnittstelle.
Der Mensch von damals hat den Code geschrieben und der Mensch von heute soll ihn lesen, vielleicht sogar abändern.

Klar gibt es jetzt eine Menge Interpretationsspielraum.

  • Was habe ich damals gemacht?
  • Wozu die Schleife?
  • Wozu diese Verschachtelung?
  • Warum ist die Variable öffentlich?

Und dann versuchst Du diesen Code zu ändern und natürlich passiert genau das was passieren muss.

Im besten Falle zerschießt Du das Programm.

Im schlimmsten Fall, veränderst Du Variablen und Konstrukte und bekommst gar nicht mit, was sich dadurch alles ändert.

Erst Deine Benutzer bemerken irgendwann große Fehler.
Au Mist…..

Oder Du bist zu ängstlich den Code zu ändern, dass Du wochenlang herumgrübelst und einen Programmierpfad nach dem anderen durchläufst.
Das ist doch auch Mist.

Geht doch besser oder?

Klar! Du solltest von Anfang an den Interpretationsspielraum eingrenzen und Dich somit vor Dir selbst schützen.

Und deshalb solltest Du deinen Code kommentieren.
Jetzt kommen die Kommentare ins Spiel.

Darauf solltest du beim Setzen der Java Kommentare achten.

Kommentare haben nicht den Zweck deinen Code in Pseudocode zu wandeln.

Wenn du ein Kommentar zu einer Schleife schreibst, schreibe nicht:
Durchlaufe x bis das Ende des Arrays erreicht ist und dann gib die Anzahl der Durchgänge zurück.

Denn genau das siehst du ja schon, wenn du dir die Schleife anschaust.

Gehe besser auf das Warum ein:

  • Warum muss die Schleife durchlaufen werden?
  • Warum brauchst du die Anzahl der Schleifendurchläufe?
  • Warum startet die Schleife bei 1 und nicht bei 0.

Warum ist es eine For-Schleife und nicht eine While-Schleife.

All das kommt in dein Kommentar.

Setze einen Kommentare hinter jede Instanzvariable.

Hinter Instanzvariablen setzt du immer einen einzeiligen Kommentar.

Dort schreibst du weder den Datentyp, noch den Namen.
All das siehst du schon, wenn du dir die Variable anschaust.

Du schreibst die Maßeinheit dahinter.

  • Größe in Meter
  • Zeit in Sekunden
  • Oder Ähnliches.

Denn die Maßeinheit wird schnell einmal aus den Augen verloren.

Dann schaust du dir deinen Code irgendwann wieder einmal an.

Und das große Rätselraten geht los.
Im schlimmsten Fall setzt du dann für weitere Zusatzmodule die falschen Maßeinheiten fest.

Oder du probierst es selbst aus und verschwendest Zeit.

Fazit:

  • Kommentare sollten in der Programmierung dazu genutzt werden, den Code verständlich zu machen.
  • Und nicht nur verständlich für Außenstehende.
    Vorwiegend sollte der Code für dich verständlich sein.
  • Hinter jeder Instanzvariablen sollte deshalb eine Größen- oder Maßeinheit geschrieben werden.
  • Über den Methoden kannst du mehrzeilige Java Kommentare nutzen, um das Warum des Codes zu erläutern.

Hat dir der Beitrag gefallen?
Hast du vielleicht etwas auszusetzen oder zu ergänzen – Dann nutze doch das Kommentarfeld unter diesem Beitrag.


Ähnliche Beiträge

So kannst du Instanzen in Java Klassen zählen

Wie kannst du die Instanzen der Java Klassen zählen? Ganz einfach. Am besten ist es, wir bleiben beim Einführungsbeispiel zu den Java Klassen. Und ich wähle die Klasse „Monster“. Um es einfach zu halten, soll auch der Programmstart durch die Klasse erfolgen. Die Klasse bietet somit eine main-Methode an.

Java Exklusives Oder – So nutzt du den Xor Operator

Java exklusives oder

In diesem Beitrag möchte ich dir den Xor Operator von Java vorstellen. Dieser Operator wird auch als ausschließendes oder exklusives Oder bezeichnet. Ein Beispiel: Was wilst du heute zum Mittag essen: Fleisch oder Fisch? Auf diese Frage gibt es nur eine Antwort. Es ist entweder Fisch oder Fleisch. Niemals beides. Das Eine schließt das andere […]

So kannst du Java Arrays mit for Schleife füllen und auslesen

Java Arrays For Schleife

Wir haben in einem anderen Beitrag bereits über Java Arrays gesprochen. So ein Array speichert Zahlen, Texte oder Objekte in eine Art Liste. Und dann kannst du ganz bequem über den Index das Array füllen und die bereits enthaltenen Werte abrufen. Ganz bequem? So, wie ich dich aus dem letzten Beitrag entlassen habe, war das […]

So kannst du in Java Und Verknüpfung anlegen und auswerten

Java Und

In Java stehen dir eine Menge Operatoren zur Verfügung. Einer dieser Operatoren ist der Und-Operator. Dies ist ein logischer Operator, da dieser sogenannte Wahrheitswerte mit einander verknüpft. Also…. Was erwartet dich in diesem Beitrag? Zuerst möchte ich dir die Aussagenlogik hinter dem Und-Operator zeigen. Also wann sind Aussagen wahr und wann sind diese falsch. Dann […]

Java Methoden mit variabler Argumentenanzahl – VarArgs

Java Methoden mit variabler Argumentenanzahl VarArgs

Du kennst das noch. Kopfrechnen und zwar auf Zeit. So etwas ist das Standardprogramm in den Schulklassen 1 bis 5. Irgendwann, in Klasse 6 oder 7, kommt der Taschenrechner ins Spiel und Kopfrechnen ist aus dem Schulalltag gestrichen. Schade eigentlich. Dabei kann man diese Disziplin auch wunderbar in kleinen Spielen unterbringen. Ich erinnere mich noch: […]

So nutzt du getter und setter Methoden bei der Java Programmierung

Java Keyword private

In diesem Artikel möchte ich dir zeigen, wie du Instanzvariablen innerhalb der Java Klasse schützt. Und den Zugriff nur noch indirekt über getter und setter Methoden anbietest. Stell dir vor. Du hast ein Programm zur Lagerverwaltung geschrieben. Dieses Programm dient Möbelhäusern dazu, ihre Bestände zu verwalten. Und das Programm erwartet vom Nutzer gewisse Eingaben zu […]

Beim Aufruf werden Java Methoden auf dem Stack gestapelt

Java Methoden gestapelt

Java Methoden werden beim Aufruf gestapelt. Und jedes Element auf dem Stapel nimmt Speicherplatz weg. Und manchmal ist es so, dass der Stapel richtig hoch wird und dann…. Ja was passiert eigentlich dann? Betrachten wir einmal ein Computerspiel. Irgendeines. In diesem Computerspiel gibt es Vögel, welche abgeschossen werden sollen. Was bedeutet das denn genau? Beim […]

So kannst du ein Java Programm starten und Argumente übergeben

Um ein Java Programm starten zu können, benötigst du immer die main-Methode. Das Programm startet immer genau an dieser Stelle. Alle lokalen Variablen, welche du in der Main Methode anlegst, kannst du dann im Programm nutzen. Auch alle Methoden, welche du innerhalb des Methodenrumpfes der main-Methode aufrust, werden ausgeführt. Was ist aber vor der main-Methode. […]

10 ganz nützlichen Feature der Klasse Java Math

In diesem Beitrag geht es um eine spezielle Java Klasse. Die Klasse nennt sich Java Math. Diese ist in der Standardbibliothek von Java enthalten. Warum solltest du diese Klasse kennen? Die Math Klasse bietet dir einen Menge Methoden an, welche zur Berechnung von mathematischen Gleichungen ganz hilfreich sind. Aber auch für Nichtmathematiker ist etwas dabei. […]

So erstellst du deine ersten Java Klassen mit Eclipse

Java Klassen sind Baupläne für Java Objekte. Und da Java eine objektorientierte Programmiersprache ist, sind Java Klassen somit ein elementarer Bestandteil. In diesem Beitrag möchte ich dir zeigen, wie du eine Java Klasse in Eclipse erstellen kannst. Ich möchte dir außerdem zeigen, was physikalisch in deinem Projekt passiert. Ganz zum Schluss zeige ich dir noch, […]