So solltest du Kommentare im Java Programm einsetzen
Bei der Java Programmierung sind Kommentare mitunter genauso wichtig wie der eigentliche Code. Denn ein guter Kommentar zeigt dir sofort, was mit dem Code gemeint ist, was dieser bewirkt und was sich der Entwickler dabei dachte.
Inhalt
Wie werden Kommentare in Java gesetzt?
Die Kommentare werden in Eclipse immer grün dargestellt.
Sie beginnen mit einem doppelten Schrägstrich.
//Das ist ein Kommentar
Kommentare, welche über mehrere Zeilen gehen, beginnen mit einem /* und enden so: */.
Diese sind ebenfalls grün.
/*
*Dies ist ein mehrzeiliger Kommentar.
*/
Im internen Programmauflauf werden Strukturen – welche mit /* oder mit // beginnen, gekonnt übersprungen. Die Entwicklungsumgebung erkennt dies als Kommentar an.
Worauf sollte beim Setzen von Kommentaren geachtet werden
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.
Über den Autor
