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

Der Aufbau von Java Klassen

Java Klassen Aufbau

Jedes Java Programm besteht aus Java Klassen. Doch wie sind diese aufgebaut? Wie setzt sich die Struktur zusammen? Wo befinden sich Klassen hierarchisch? Was kommt in die Klassen rein und wie wird es integriert? Das sind die Fragen, welche ich in diesem Artikel beantworten werde. Doch bevor wir bei den Klassen ansetzen, müssen wir eine […]

Sicherer Schleifendurchlauf mit Do while Schleife

Java Do While Schleife

Es ist doch eigentlich so: Immer wenn du die Anzahl der Schleifendurchläufe nicht kennst, nutzt du in deinen Java Programmen while Schleifen. Doch Java bietet dir neben der While Schleife einen weiteren Schleifentyp an. Diese nennt sich do while Schleife. Was kann die? Eigentlich genau das Gleiche, wie die while Schleife. Mit einem kleinen aber […]

Von Java Klassen zum Java Programm – Der Programmstart

Java Klassen ausführen

In den letzten Beiträgen hast du gelernt, wie Java Klassen erstellt werden und aufgebaut sind. In diesem Beitrag geht es um den Programmstart. Ich will dir zeigen, was nötig ist, dass du ein Java Programm ausführen kannst. Und ich zeige dir außerdem, wie du eine Startklasse in einem x-beliebigen Javaprogramm anlegst. Wie auch schon zuvor, […]

Java lernen – 10 nützliche Tipps für Java Anfänger

Java Lernen Anfänger

Wenn du die Programmiersprache Java lernen möchtest, bist du hier prinzipiell erst einmal richtig. Und wenn du es wirklich ernst meinst und in die Java Programmierung einsteigen möchtest, solltest du auch meinen kostenlosen Java Kurs beanspruchen. Wenn du dabei bist, bekommst du: Eine Lektion pro Woche zu den Basics. Hier geht es um die ersten […]

Der Java Datentyp boolean im Interview

Java boolean

Nein, ich bin nicht verrückt. Aber… Neulich traf ich zufällig den Java Datentyp boolean. 🙂 Er erklärte sich bereit, mir ein Interview zu geben. In diesem Interview geht es um die Werte, welcher dieser Wertetyp annehmen kann. Und in diesem Zusammenhang geht es auch um Logik. Also lassen wir uns doch die Logik vom direkten […]

So verwendest du den Java Oder Operator

Java Oder Operator

Kennst du das auch aus deiner Schulzeit? Du schreibst eine Klassenarbeit in irgendeinem Fach. Nehmen wir einfach mal an – Mathe. Jetzt bist gerade fertig mit deiner Arbeit. Und zu Hause wirst du gefragt: „Und wie lief es?“ Du antwortet:“ Ganz gut. Es wird bestimmt eine Eins oder eine Zwei.“ Drei oder vier Tage später […]

So implementierst du Instanzmethoden in deine Java Klasse

Java Instanzmethoden

In einen der letzten Beiträge habe ich dir gezeigt, wie du eine Klasse anlegen kannst. Ich habe die Klasse „Mensch“ oder „Human“ angelegt und wir haben die erste Instanzvariable implementiert. Dein Code sollte jetzt so aussehen: public class Human { int size=156;//size in centimeter } In diesem Beitrag werde ich dir zeigen, wie du Java […]

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.

Du musst in Java nicht jede Exception fangen

Java Exception fangen

Kennst du die Metapher mit dem Jongleur und den Bällen? Ein Jongleur hält drei Bälle in der Luft, dann vier und irgendwann fünf. Aber irgendwann ist es genau ein Ball zu viel. Und Alles bricht zusammen. Ja ein Ball zu viel, kann alles versauen. 🙂 Und so ist es doch immer im Leben. Du kannst […]