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 gelöschte Java Projekte oder Dateien in Eclipse wieder herstellen

Wahrscheinlich passiert es jedem einmal, dass man versehentlich Dateien löscht. Und dann? Die Wut ist riesig, weil man ja alles nochmal schreiben muss. In Eclipse hast du die Möglichkeit sämtliche Dateien wieder herzustellen. In diesem Beitrag möchte ich dir demonstrieren, wie du gelöschte Java Klassen, Dateien, Projekte oder Packages wieder herstellen kannst.

So nutzt du Methoden aus der Java String Klasse

Java Strings Methoden

In einen der letzten Beiträge haben wir darüber gesprochen, dass Java Strings – Objekte sind. Dass Strings in allen Programmen äußerst häufig vorkommen Und dass sich deshalb Referenzvariablen String-Objekte im String Pool teilen. Das Konzept hinter dem String-Pool ist die Teilung der Ressourcen. Und das bedeutet: Weniger Objekte – mehr Speicher Mehr Speicher – bessere […]

Java Übung 26 – Das erste kleine Java Spiel

Java Übung Zahlenraten

In dieser Java Übung geht es darum ein kleines Java-Spiel zu erstellen. Und zwar Zahlen raten. Was kannst du dir darunter vorstellen? Du gibst einen bestimmten Wertebereich an. Zum Beispiel 0 bis 100. Und das Java Programm erstellt eine Zufallszahl in diesem Bereich. Dann fordert dich das Programm auf, die Zahl zu raten. Du gibst […]

So kannst du dein Java Programm mit der main Methode ausführen

Auf zum ersten Java Programm. Vielleicht fragst du dich jetzt gerade: Na, was haben wir denn bisher gemacht? War das etwa kein Java Programm? Wir haben bisher nur eine Klasse „Human“ für ein zuküntfiges Mensch-Objekt erstellt. Diesem Objekt haben wir eine Instanzvariable, namens size (Größe) zugeordnet. Und wir haben eine Instanzmethode, namens grow (wachsen) geschrieben. […]

Java Exceptions Handling – Fehler- und Ausnahmenbehandlung in Java

Java Exceptions Handling

Java Exceptions Handling umfasst den richtigen Umgang mit Ausnahmen und Fehlern. Wie geht das? Und braucht man so etwas wirklich? Vielleicht sagst du jetzt: „Brauch ich nicht. Ich mache niemals Fehler.“ Doch… Bei der Java Fehlerbehandlung geht es nicht ausschließlich nur um deine Programmierfehler. Es geht auch um falsche Nutzereingaben, Hardware- und Ablauffehler. Und deshalb […]

Verwalte deine Java Klassen in packages

java klassen verwalten

Es macht durchaus Sinn deine Java Klassen in verschiedenen Paketen zu organisieren. Wieso? Es sprechen mehrere Gründe dafür: Du kannst doppelte Klassennamen verwenden Du kannst deinen Code oder deine Klassen inhaltlich trennen Du kannst Hierarchien abbilden. Und genau um diese Dinge geht es in diesem Beitrag

Nutze die richtigen Methoden zum Java Lernen

Java lernen Methoden

Ich lernte die Java Programmierung auf die klassische Art. Ich kaufte mir das erste Buch und los ging es. „Jetzt wirst du Java lernen“ – sagte ich zu mir. Ich war relativ schnell ziemlich frustriert, denn irgendwie fehlten mir ein paar Zusammenhänge. Kennst du das? Du hast ein Wissensfetzen und noch einen. Aber das Wichtigste. […]

So verwendest du Inkrement und Dekrement Operatoren in deinen Java Programmen

Java Operatoren

In diesem Beitrag geht es um Java Operatoren. Ich möchte dir gern zwei neue Operatoren vorstellen. Diese nennen sich Inkrement und Dekrement. Ja was heißt das? Inkrementieren bedeutet eine schrittweise Erhöhung einer Zahl. Und dementsprechend bedeutet Dekrementieren: Die schrittweise Verminderung einer Zahl. Wozu brauchst du das? Stell dir vor. Du bekommst eine Liste mit Namen […]

Java Strings landen im String Constant Pool

Java-Strings-Pool

Du kennst das. Es ist abends. Du sitzt gemütlich vor dem Fernseher. Das Smartphone bimmelt. Kein Anruf. Nein – Eine Nachricht. Du liest die Nachricht sofort und antwortest darauf. Minuten später bekommst du die nächste Nachricht. Und auch auf diese antwortest du. Im Laufe des Abends entsteht daraus eine nette kleine Konversation. Und eh du […]