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

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

Drei Möglichkeiten um Java Objekte zu zerstören

Java Objekte zerstören

Java Objekte leben genau solange, wie eine Referenzvariable auf sie zeigt. Wenn dieser Zeiger nicht mehr existiert, wird dieses Objekt aufgeben. Und wenn dieses Objekt erst einmal aufgegeben wurde, dann kommt der Garbage Collector und entsorgt dieses. Aber wie kannst du nun am Sinnvollsten Objekte aufgeben? Lass es uns herausfinden.

3 Möglichkeiten – Java Strings verketten und zusammenfügen

Java Strings verketten

Kennst du dieses Relikt längst vergangener Tage? Ein Brief. Ja früher einmal war es üblich, Briefe zu schreiben. Lange bevor es Smartphones oder Email gab. Man stelle sich einmal vor…. Die Leute mussten sich hinsetzen mit einem Blatt und einem Stift – und richtig schreiben. Nein nicht tippen – schreiben. 🙂 Grausame Welt, oder? Aber […]

So unterstützen dich Java Vererbungstabellen beim Entwurf

Java Vererbungstabellen

Bei der Java Vererbung gibt es zwei Klassenarten bzw. -stufen. Die Superklassen, welche einen allgemeinen Typen darstellen Und die spezielleren Unterklassen, welche die Superklasse um bestimmte Funktionen erweitern. Jetzt ist dieses ganze „Der-erbt-von-dem-Konzept“ mitunter sehr schwierig darzustellen. Zum Beispiel in einem Werkzeugkoffer. In einem Werkzeugkoffer befinden sich sämtliche Werkzeuge, von Säge bis Bohrmaschine. Wie machst […]

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

Java Übung 27 – Auf zur Mathe-Olympiade

Java Übung Mathe Olympiade

In dieser Java Übung möchte ich mit dir ein Programm erstellen, welches ein Mathematik-Test oder eine Mathe-Olympiade simuliert. Du kennst das vielleicht noch aus der Schule. Matheolympiade- Da wurden aus allen vier Grundrechenarten, Aufgaben formuliert. Die Schüler mussten diese Aufgaben lösen. Die Lehrer kontrollierten die Lösungen. Und der Schüler, welcher die wenigsten Fehler hatte – […]

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

So einfach lassen sich Java Strings umkehren

Java Strings umkehren

Kennst du noch das Lied „ANNA“ von Freundeskreis? Da hieß es: Du bist von hinten, wie von vorne A-N-N-A. Solche Namen oder Wörter, welche von hinten nach vorne gelesen – die gleiche Bedeutung haben, nennt man Palindrome. Anna, Ehe oder Ebbe sind recht kurze Palindrome. Aber auch längere zusammengesetzte Palindrome kennt die deutsche Sprache: Regallager […]

So kannst du in drei einfachen Schritten Java Arrays dynamisch vergrößern

Java Arrays vergrößern

Es ist der 31.März 1727. Es ist ein Montag. Die Welt nimmt Abschied von einem sehr bedeutenden Weltveränderer. Seine Sichtweisen beeinflussen, heute noch, die Forschung und Entwicklung im Bereichen der Physik und Chemie. Ja selbst unser aller Leben – unsere Sicht auf die alltäglichen Dinge – wurden durch seine Denkstöße revolutioniert. Dieser große Vorreiter starb […]