Java Code Conventions

Worum geht´s?

Code Conventions sind gewissermaßen „übliche“ Vorgehensweisen, wie Java-Code aussehen soll. Er ist nicht in Stein gemeißelt, und je nachdem in welchem Team du arbeitest werden einige Konventionen auch davon abweichen. Dies hier soll nur eine grobe Übersicht bieten.

1. Variablen:

• Kleinbuchstabe am Anfang: Variablen beginnen in Java immer mit einem kleinen Buchstaben.
• Erlaubte Zeichen: Nach dem ersten (kleinen!) Buchstaben sind nur kleine und große Buchstaben, Zahlen und Unterstriche (_) erlaubt.
• Camel-case-Schreibweise: Besteht dein Variablen-Name aus mehr als einem Wort (z.B. „visitorAge“), dann beginnt jedes neue Wort (außer dem ersten) mit einem großen Buchstaben. Das macht Variablen-Namen besser lesbar.
• Englische Sprache: Um deinen Code international besser lesbar zu machen, verwende englische Variablen-Namen.
• „Sprechende“ Variablen-Namen: Aus dem Namen der Variable sollte ablesbar sein, wofür sie verwendet wird. (So könnte eine Variable, die ein Alter beschreibt, beispielsweise auch age heißen. Ausnahme sind „Wegwerf-Variablen“ wie z.B. Zählvariablen in Schleifen, die du nur 1x kurz verwendest und dann nie wieder. Diese dürfen gerne weiterhin einzelne Buchstaben wie a, x oder i heißen.)

2. Klammer-Setzung:

• Alles, was zwischen geschwungenen Klammern {} steht, wird um genau 1 TAB eingerückt.
• Steht zwischen den geschwungenen Klammern nur genau 1 Befehl, dürfen die Klammern auch weggelassen werden. Anfangs kann es für dich einfacher sein, sie trotzdem zu machen.

3. Kommentare

• Kommentiere deinen Code dort, wo er nicht selbsterklärend ist, mit „Notizen“
• Wenn dein Programm länger als 50-100 Zeilen ist, schaffe mit Kommentaren „Zwischen-Überschriften“, wo es Sinn macht
• Wenn du einen Teil deines Codes zum Testen/Fehler finden „überspringen“ willst, kannst du diesen Teil „auskommentieren“, also zum Kommentar machen
• Mit // wird die ganze Zeile rechts der Schrägstriche zum Kommentar
• Mit /* aalkasjdlkfjaslkdfjlkasdjflka */ kannst du auch mehrere Zeilen zum Kommentar machen
• In IntelliJ kannst du mit dem Shortcut STRG + / (Numblock) mehrere markierte Zeilen auskommentieren/wieder zurücksetzen

4. Logisch zusammengehörende Code-Blöcke

• Gruppiere deinen Code mit Hilfe von Leerzeilen so, dass logisch zusammengehörige Code-Blöcke in „Absätzen“ zusammengefasst sind.

5. Clean Code

• Kannst du deinen Programmcode auf weniger Code-Zeilen kürzen, ohne dass er a) erheblich schlechter lesbar wird oder b) weniger gut funktioniert?

Hinweis: Mit Hilfe von Rechtsklick->Refactor->Rename (Shortcut STRG + F6) kannst du in IntelliJ Variablen in der ganzen Klasse auf einmal umbenennen – das spart viel Zeit!

Diskussion zum Tutorial