Skip to content

Latest commit

 

History

History
14 lines (11 loc) · 1.58 KB

java.md

File metadata and controls

14 lines (11 loc) · 1.58 KB

Java Guidelines

Dir werden hier unsere generellen Java Guidelines vorgestellt. An diese muss sich gehalten werden, damit wir einen möglichst Einheitlichen CodeStyle in unseren Projekten gewährleisten können.

Als Codestyle ist im Java Bereich das Google Java Format in Verwendung. IntelliJ-IDEA-Benutzer haben die Möglichkeit diesen in ihre IDE über eine XML-Datei zu übernehmen. Wie das funktioniert kann hier nachgelesen werden.

Zusätzliche Punkte

  • this bei instanzspezifischen Methoden oder Variablen verwenden.
  • Immer super verwenden, wo angebracht! Beispiel: Bei der Verwendung von Methoden der Mutterklasse super.doWork()
  • Wenn möglich java.util.Optional<T> verwenden, anstatt null. Mehr Informationen darüber gibt es hier
  • Abstrakte Klassen und Interfaces werden nicht mit einem Präfix versehen - Ausnahmen sind z.B. List und AbstractList bei abstrakten Klassen; Interfaces bekommen nie den I Präfix. Beispiel: Es sollte Command statt ICommand verwendet werden.
  • Jede Variable und jedes Methodenargument das mit final gekennzeichnet werden kann, sollte auch so gekennzeichnet werden.
  • Jede Methode sollte mit JavaDoc versehen sein, ausser es ist besonders offentlichtlich, was die Methode bewirkt. Beispiel: Getter/Setter Methoden

Wir empfehlen für IntelliJ-IDEA-Benutzer das Save-Actions Plugin, damit sichergestellt ist, dass unser Codestyle eingehalten wird.