Hier findest du alle Beiträge die mit dem Tag cleancode versehen sind.
Bevor du nicht mindestens tausend Getter & Setter geschrieben hast, verwendest du kein Lombok!
Mit diesem Worten meines Kollegen begann irgendwann meine Karriere als Java-Entwickler. Und er sollte damit auch recht behalten …
Project Lombok, dass ist eine Java Bibliothek die einem viel Arbeit abnehmen kann aber auch Risiken birgt. Unter anderem können damit Getter & Setter sowie Konstruktoren automatisiert (zur Compilezeit) erstellt werden. Dadurch enthält der Java-Code auf den ersten Blick zunächst nur das Nötigste was ihn deutlich lesbarer macht. Dies wird durch den Einsatz von Annotationen realisiert.
Durch Dinge wie CleanCode oder dem KISS-Prinzip versuchen wir unseren Code möglichst verständlich zu halten. Wir benennen Methoden nachdem was sie tun, wissen, dass eine Methode auch nur eine Sache machen soll und auch die Benamung unserer Variablen sind sprechend.
Wer das alles konsequent berücksichtigt, der wird in den meisten Fällen keine Kommentare im Quelltext hinterlassen müssen – so zumindest der Wortlaut vieler Dozenten und Autoren.
In der Praxis sieht das oft aber ganz anders aus.
Das Thema Code-Style, in Bezug auf die Benamung von Variablen und Methoden, hatte ich ja in einem anderen Beitrag angesprochen. In Bezug auf die Benamung ist es allerdings gut etwas mehr in die Tiefe zu gehen und einen genaueren Blick darauf zu werfen.
Ganz grundsätzlich aber gilt: Bennene deine Variable / Methode danach wofür sie steht oder was sie macht. Punkt! Das hilft dir deinen Code auch später noch zu verstehen oder glaubst du, du kannst dich in einem Jahr noch erinnern, warum der String der Klasse Tier eigentlich ä heisst und wofür er steht?
Ja, das ist der eigentliche Kern der Sache und so einfach es auch klingt, so schwer scheint es manches mal zu sein.
Das Thema “Code Style” ist gerade für Anfänger im Bereich der Programmierung nicht immer so leicht umzusetzen. In diesem Beitrag geht es zunächst einmal um die optische Optimierung des Codes. Wie du Variablen und Methoden nach den Konventionen schreibst, habe ich hier bereits aufgeschrieben. Nun geht es aber um einen ordentlichen Style, damit man deinen Code auch gut lesen kann.
Um das Ganze anschaulich und nachvollziehbar zu machen, nehmen wir das Beispiel der Klasse Computer. Der Computer hat bestimmte Eigenschaften und kann bestimmte Dinge tun. Er hat Variablen, Konstanten und natürlich auch Methoden.

Hi, ich bin Marcel!
Als Fachinformatiker für Anwendungsentwicklung und IHK-geprüfter Ausbilder teile ich auf meinem Blog Grundlagen- und Fortgeschrittenen-Wissen für angehende Entwickler*innen und Interessierte, sowie weitere spannende Themen aus der IT.