Konventionen

Das Wichtigste beim Programmieren ist, dass man die Kommentare nicht vergisst. Dadurch weiß man, was man sich beim Programmieren gedacht hat… kann ja schließlich etwas länger zurückliegen…

Genauso wichtig (oder gar wichtiger?) ist Folgendes:
Damit Code lesbar ist - undzwar nicht nur von einem selbst, sondern auch von Dritten - braucht man Vereinbarungen, an die sich alle halten. Diese sind für die Sprache nicht zwingend nötig, auch dem Computer ist es absolut egal, doch beschleunigen sie die Analyseprozesse für den Benutzer - nein, für alle Benutzer. ;-)

Diese Vereinbarungen (auch Regeln) nennt man Konventionen.

Übrigens: Sun hat schon an diese Konventionen gedacht und eine globale festgelegt. Es ist empfehlenswert sich daran zu halten: Code Conventions for the Java™ Programming Language

Einige dieser Konventionen sollen hier nun aufgezeigt werden.

Die goldenen Regeln der Code-Formatierung

Regel 1

Zusammenhängende Blöcke (Teile) einrücken 1).

Beispiel (falsch):

public static void unlesbar(int z) {
System.out.println("Hallo Welt.");
if (z < 3)
System.out.println("Schönes Wetter heute");
else
System.out.println("Mistwetter!");
}

Beispiel (richtig):

public static void unlesbar(int z) {
    System.out.println("Hallo Welt.");
    if (z < 3)
        System.out.println("Schönes Wetter heute");
    else
        System.out.println("Mistwetter!");
}

Regel 2

Niemals mehr als ein Befehl in eine Zeile schreiben!

Beispiel (falsch):

public static void unlesbar(int z) {
    System.out.println("Hallo Welt.");
    if (z < 3) System.out.println("Schönes Wetter heute");
    else System.out.println("Mistwetter!"); System.out.println("Ciao");
}

Beispiel (richtig):

public static void unlesbar(int z) {
    System.out.println("Hallo Welt.");
    if (z < 3)
        System.out.println("Schönes Wetter heute");
    else
        System.out.println("Mistwetter!");
    System.out.println("Ciao");
}

Regel 3

Sich öffnende geschweifte Klammern stehen am Ende des vorangehenden Befehls, sich schließende Klammern in einer eigenen Zeile. Es gilt: diese werden so eingerückt, dass sie mit dem Beginn der Zeile übgereinstimmen, in der die zugehörige offene Klammer steht. Außer bei do-while-Schleifen darf in dieser Zeile kein weiterer Befehl stehen.

FIXME

Regel 4

FIXME

Die goldenen Regeln der Namensgebung

Regel 5

Klassen- und Konstruktornamen beginnen immer mit einem großen Buchstaben.

Setzen sich Namen aus mehr als einem Wort zusammen, wird jedes Wort mit einem Großbuchstaben begonnen.
In der Fachsprache heißt dies Camel_Caps

  * MeineErsteKlasseDieIchProgrammiere
  * Auto
  * Auto()
  * ...

Regel 6

Variablen- und Methodennamen beginnen immer mit einem Kleinbuchstaben.

Auch hier gilt: Setzen sich die Namen aus mehr als einem Wort zusammen, wird jedes Wort (außer dem ersten) mit einem Großbuchstaben begonnen.

  * beispielMethode()
  * gefahreneKm
  * i
  * ...

Regel 7

Konstanten werden mit Großbuchstaben bezeichnet.

Setzt sich eine Konstante aus mehreren Worten zusammen, werden diese durch Unterstriche voneinander getrennt.

  * GROESSTER_WERT_WO_GIBT
  * PI_HALBE
  * ...
1) ein TAB bzw. mindestens 4 Leerzeichen
start/info/11if/java_konventionen.txt · Zuletzt geändert: 23.10.2013 10:12 (Externe Bearbeitung)
www.chimeric.de Creative Commons License Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0