Prof. Dr. Pape - Java Programmierrichtlinien - Einleitung

• Home
  • Vorlesungen
    • Informatik 1
    • XML
    • EAI
  • Labore
  • Seminare
  • Studienarbeiten
  • Abschlussarbeiten
  • Projekte

Java Programmierrichtlinien - Einleitung

Hier befinden sich die meisten in der Vorlesung Informatik 1 behandelten Programmierrichtlinien in übersichtlicher Form. Es handelt sich dabei mehrheitlich um Programmierrichtlinien aber auch um einige Entwurfsrichtlinien. Die Regeln sind so gruppiert, dass Richtlinien, welche die gleichen Programmiersprachelemente betreffen meist beieinander stehen.

Die hier aufgeführten Programmierkonventionen sind im wesentlichen übereinstimmend mit den von Sun herausgegebenen Java Code Conventions. Sie entsprechend auch meiner Erfahrung nach dem, woran sich die meisten Java-Programmierer in der Praxis halten – zumindest sofern überhaupt Programmierkonventionen und ein Stil in den Java-Quelltexten erkennbar sind. Beachte, dass für weiterführende Java-Technologien wie Java Server Pages, Servlets und Enterprise Java Beans noch zusätzliche Richtlinien existieren (siehe dazu java.sun.com).

Viele der hier aufgeführten Programmierrichtlinien sind auch gar nicht Java-spezifisch oder nur für objekt-orientierte Programmierung sondern gelten für alle Programmiersprachen. Manche der aufgeführten Konventionen sind nicht gleich wichtig – auf eine entsprechende Kennzeichnung habe ich verzichtet.

Normalerweise sollten Programmierrichtlinien sehr kurz sein: etwa 2-3 Seiten. Sind sie länger, dann liest sie keiner und die Regeln werden dann überhaupt nicht angewendet. Diese Kürze ist später in den Programmierrichtlinien einer Firma auch bedenkenlos machbar: die Regeln brauchen dort gar nicht begründet und viele auch nicht mehr erwähnt zu werden, da sie bis zum Ende der Informatikausbildung teilweise in Fleisch und Blut übergehen (sollten). Da die hier aufgeführten Programmierrichtlinien aber für die Ausbildung von Informatikstudenten im ersten Semester dienen, enthält dieses Dokument entsprechend viele Regeln und detaillierte Begründungen. In der Projektpraxis empfiehlt es sich diese Regeln mit entsprechenden Funktionen der verwendeten Entwicklungsumgebung durchzusetzen (Warnung bei Nichteinhaltung, automatische Formatierung).

Die Kurzfassung einer Regel ist optisch hervorgehoben. Der Kurzfassung folgen Beispiele und eine ausführliche Begründung. Einfache dem Verweis der Regel folgen.

Übersicht über die Java-Programmierkonventionen

Java-Namenskonventionen

Bezeichner

• Aussagekräftige Namen wählen wie Kraftfahrzeug, BundesagenturFuerArbeit, HochschuleKarlsruhe, DeutscheBahn
• Vermische keine verschiedenen Sprachen in Quelltexten.
• Verwende ausschließlich die alphanumerischen Zeichen A-Z, a-z, 0-9 und den Unterstrich _ für Bezeichner.
• Verwende Upper Case Camel Style

Variablen, Attribute und Parameter

• Schreibe Variablen klein mit Anfangsbuchstaben von Teilwörtern gross wie bei anzahl, anzahlErbsen
• Schreibe Konstanten mit Grossbuchstaben und trenne Teilwörter mit _ wie bei ERG_GRAVITATION, PI
• Verwende mindestens ein Substantiv für Variablen
• Verwende i,j,k,l für Zählvariablen, wenn diese sonst keine weitere Bedeutung haben
• Stelle das Schlüsselwort this immer Objektattributen voran
wie bei this.koordinate, this.adresse
• Verwende keine Ungarische Notation

Methoden

• Verwende mindestens ein Verb im Namen der Methode wie personSuchen(), loeschen(), produktVerkaufen()
• Verwende getter und setter zum Zugriff auf Objektattribute wie String getVorname(), void setVorname(String vorname)

static

• Referenziere Klassenvariablen immer mit Klassennamen wie bei Math.abs(-16), Color.red, System.out

Packages

• Verwende nur Kleinbuchstaben für Paketnamen
• Verwende nie java oder javax für Paketnamen

Quelltextformatierung

Allgemein

• Mische in einer Klasse nie verschiedene Programmierstile
• Schreibe nicht mehr als 80 Zeichen pro Zeile (zumindestens nie mehr als auf einmal auf dem Bildschirm zu sehen sind)

Anweisungen

• Verwende bei Kontrollanweisungen immer gescheifte Klammern und rücke die Befehle darin ein
• Bei einem direkt auf ein if folgendes else wird das if (als Ausnahme) nicht in geschweifte Klammern gesetzt
• Verwende einen definierten Klammerungsstil (es gibt drei Varianten)
• Schreibe jede Anweisung auf eine neue Zeile
• Vermeide continue und break
• Verschachtele Kontrollanweisungen höchsten bis zu dreimal ineinander

Ausdrücke

• Setzte vor und nach jedem binären Operator ein Leerzeichen wie bei 1 + b / langerBezeichner * (1 - x)
• Breche überlange Ausdrücke vor dem Operator mit der schwächsten Bindung um
• Vergleiche Boolesche Werte nicht mit ==: statt esRegent == true schreibe esRegent und esRegent == false schreibe ! esRegnet
• Wähle für einen Ausdruck die selbe Operatorenreihenfolge wie ein einem mathematischen Ausdruck, implementiere 0 < i < j < n als 0 < i && i < j && j < n
• Vermeide Seiteneffekte
• Breche überlange Ausdrücke vor dem Operator mit der schwächsten Bindung um
• Vermische Kurzschlußoperatoren nie mit "normalen" Booleschen Operatoren

Methoden

• Schreibe kurze Methoden mit nicht mehr als 25 Zeilen
• Deklariere alle Variablen am Anfang der Methode außer Schleifenvariablen
• Vermeide Seiteneffekte in Funktionen

Verschiedenens

Datentypen

• Verwende int für ganze Zahlen und double statt float

Lokale Variablen

• Vermeide lokale Variablen, deren Wert nur genau einmal verwendet wird

Felder

• Verwende immer den Java-Deklarationsstil bei Feldern

Javadoc

Allgemeines

• Beschreibe was eine Methode macht, nicht wie sie es macht
• Beschreibe was die Werte von Variablen bedeuten, nicht wie die Variablen verwendet werden
• Schreibe Kommentare immer kurz aber spezifisch

Klassen

• Dokumentiere Entwurfsentscheidungen im Klassenkommentar
• Dokumentiere nicht, wo die Klasse verwendet wird

Attribute

• Dokumentiere die Bedeutung von Attributen und Variablen

Methoden

• Beschreibe im ersten Satz, was die Methode macht und beschreibe alle Parameter und den Rückgabewert