Java-Doc – es ist ein absolutes MUSS!

Java • 6. Juli 2021 • Lesezeit: 5 Minuten

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.

Weiterlesen