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 legst du Utility Klassen in Java an

Java Utility Klassen

Utility Java Klassen – was ist das? Man nennt diese auch Hilfsklassen von Java. Diese Utility Klassen sind Java Klassen, welche lediglich Methoden und Konstanten anbieten. Am Beispiel: Die Klasse Math ist so eine klassische Utility Klasse. Wozu braucht man solche Klassen? Diese Klassen sind so etwas wie ein Werkzeugkoffer für jedes Java Programm. Hier […]

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 […]

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 kannst du ein neues Java Projekt mit Eclipse anlegen und konfigurieren

Java Projekt anlegen Eclipse

In diesem Beitrag möchte ich dir zeigen, wie du ein neues Java Projekt mit Eclipse anlegen kannst. Ich werde dir außerdem einen kurzen Überblick über die Konfigurationsmöglichkeiten geben. Dann gebe ich dir noch eine ganz einfache Schritt-für-Schritt-Anleitung für dein allererstes Java Projekt und ich zeige dir, was nach dem Anlegen des Projektes eigentlich passiert ist.

Java Vererbung – Die Hierarchien richtig planen

Java Vererbung Hierarchien

Java Vererbung hat nichts mit Biologie zu tun. Die Genetik besagt, dass bestimmte Merkmalsausprägungen von den Eltern auf die Kinder übergehen. Solche Merkmalsausprägungen sind: die Hautfarbe die Haarfarbe die spezifische Größe und weitere körperliche Merkmale. Und in Java – was ist da Vererbung? Lass es uns herausfinden. Was erwartet dich in diesem Beitrag? Zuerst schauen […]

So kannst du Java installieren

Java installieren

Bevor du loslegst und deine ersten Java Programme schreibst, benötigst du die entsprechende Arbeitsumgebung. Du solltest also Java installieren. Und diese Arbeitsumgebung beinhaltet dann Bibliotheken für die einzelnen Java-Standard-Klassen, Dateien um deine Programme auszuführen. Dateien um deine Programme zu packen, Logische Verzeichnisstrukturen

So nutzt du das Java Keyword public

Java Keyword public

Java Programme bestehen aus Java Klassen. Und der Zugriff auf eine Java Klasse sollte nach außen immer gewährleistet sein. Was bedeutet das? Du solltest in jeder Klasse die Möglichkeit haben, ein Objekt einer anderen Klasse anzulegen. Gerade durch diese Möglichkeit macht doch das ganze Klassenkonstrukt erst Sinn.

So kannst du zweidimensionale Java Arrays anlegen und nutzen

Java Arrays zweidimensional

Eines der bedeutendsten Instrumente in der Mathematik ist das Koordinatensystem. Die gedankliche Grundlage dieses Werkzeuges lieferte der französische Naturwissenschaftler und Philosoph Rene Descartes. Man muss sich einmal verdeutlichen, was dies für die damalige Zeit bedeutete. Bisher wurden mathematische Probleme lediglich durch Berechnungen gelöst. Denke an geometrische Figuren, wie Dreiecke und Vierecke. Der Umfang wurde lediglich […]

Java Polymorphie – besserer Code und mehr Möglichkeiten

Java Polymorphie Vorteile

Polymorphie ist das Herzstück jeder objektorientierten Sprache. Nicht nur in Java – auch in Python, Javascript und in anderen Sprachen. Aber was bedeutet Polymorphie eigentlich? Polymorphie oder auch Polymorphismus genannt, kommt aus dem Griechischen. Es bedeutet Vielgestaltigkeit. Etwas freier übersetzt, kannst du es auch als Facettenreichtum bezeichnen. Im Grunde genommen zielt die ganze Java Vererbung […]

Java Übung 21 – Bestimme die Anzahl der Tage

Java Übung Tage

In dieser Java Übung möchte ich, dass du eine Methode schreibst, welche zwei Zahlen entgegennimmt. Und zwar soll die erste Zahl das Jahr sein. Die zweite Zahl soll eine Monatsangabe (1-12) repräsentieren. Was soll die Methode dann machen? Die Methode soll dir die Anzahl der Tage des jeweiligen Monats zurückgeben. Achte auf Schaltjahre.