Java Code Conventions PDF

Preview

Summary

Download Java Code Conventions PDF

Description

Praktikum Grundlagen der Programmierung Prof. Dr. Helmut Seidl, Julian Erhard, M.Sc., Gerhard Hagerer, M.Sc.

1

WS 2020/21

Überblick: Java Code Conventions

Java Code Conventions sind eine Sammlung von Best Practices, die zu einer einheitlichen Formatierung und zu einer besseren Lesbarkeit von Source-Code beitragen. Dadurch kann (neuer) Source-Code schneller und gründlicher verstanden werden, was zu einer besseren Wartbarkeit beiträgt. Viele IDEs stellen Auto-Formatter bereit um eine Datei automatisch zu formatieren. Bei Eclipse aktiviert man diesen durch die Tastenkombination Strg+Shift+F, bei IntelliJ durch Strg+Alt+L. Im Folgenden finden Sie einen groben Überblick über die wesentlichen Code Conventions. • Den Einsatz sinnvoller Datentypen. Schlecht double anzahlEinwohner;

Besser int anzahlEinwohner;

• Namenskonventionen: – Aussagekräftige und konsistente Namensgebung: Einzelne Buchstaben nur als temporärer Laufindex. Ansonsten immer selbsterklärende Namen. Schlecht // Benutzer ID int abc123 = 10;

Besser // Benutzer ID int userId = 10;

– Attribut-, Variablen- und Methodennamen werden klein geschrieben. Bei zusammengesetzten Namen beginnt jedes interne Wort mit einem Großbuchstaben. – Attribut-, Variablen- und Methodennamen werden klein geschrieben. Bei zusammengesetzten Namen beginnt jedes interne Wort mit einem Großbuchstaben. – Konstantennamen, also Namen von static final Variablen, werden in Großbuchstaben geschrieben. Bei zusammengesetzten Namen werden die Wortbestandteile durch Unterstriche getrennt. – Klassennamen beginnen mit einem Großbuchstaben und werden dann anschließend klein geschrieben. Bei zusammengesetzten Namen beginnt jedes interne Wort mit einem Großbuchstaben. • Einrückungen – Einrückung: Tabs bzw. 2-4 Leerzeichen. Sollte dann aber durchgehend konsistent bleiben! – Maximale Zeilenbreite: 120 Zeichen! – Pro Zeile ein Befehl.

– Nicht mehr als eine Leerzeile zur Separation von Blöcken, z.B. Kontrollstrukturen, Methodendefinitionen. • Dokumentation des Quelltextes – Dokumentation durch Kommentare im Quellcode. – Kommentiert wird das nicht Offensichtliche: Zweck von Klassen, Variablen, Attributen, komplexe Code-Abschnitte. – Kommentare sollten kurz, präzise und verständlich sein. – Kommentare stehen immer vor dem zu Erklärenden. – In Java können // und /* */ für Kommentare genutzt werden: 1 2 3 4

// Dies ist ein Zeilenkommentar /* Dieser Kommentar geht über mehrere Zeilen */

Hinweis: Weitere Informationen zu Code- und Namingconventions in Java finden Sie unter https://goo.gl/jo1FEJ.

2...