Skip to content

Code Style

damios edited this page Jul 31, 2020 · 16 revisions

Java Code Style

Der verwendete Formatierungsstil für den Code baut auf dem built-in Style von Eclipse auf. Wesentliche Punkte sind folgende:

  • Indentation: Tabs
  • Maximum line width: 80
  • Off/On Tags: enabled & @formatter:off, @formatter:on

Ein Profil für Eclipse kann hier heruntergeladen werden. Der Import ist über Window > Preferences > Java > Code Style > Formatter > Import... möglich. Anschließend muss das Profil entweder als Default für den ganzen Workspace oder einzeln für die vier ProjektGG-Projekte festgelegt werden. Letzteres klappt über einen Rechtsklick auf das jeweilige Projekt und Properties > Java Code Style > Formatter. Hier können projekspezifische Einstellungen über einen Haken bei Enable project specific settings aktiviert werden, und dann das jeweilige Profil unter Active profile ausgewählt werden.



File Encoding

Als File Encoding wird UTF-8, als Line Delimiter Unix verwendet. Beides kann in Eclipse nach einem Rechtsklick auf das jeweilige Projekt unter Properties > Resource festgelegt werden.


Javadoc

Die Java-Doc-Kommentare werden durchgängig in englischer Sprache verfasst, bei normalen Kommentaren kann auch Deutsch zur Anwendung kommen – je nach dem, was geeigneter ist, den jeweiligen Gedanken am konkreten Punkt zu kommunizieren.