Menu

Merkmale guter Programmierung

„Ein gutes Programm hat ein sauberes Layout, verwendet sinnvolle Namen, ist ausführlich kommentiert und verwendet Konstrukte der Sprache derart, dass maximale Robustheit und Lesbarkeit des Programms erreicht werden.

Die Erstellung eines solchen Programms erfordert vom Programmierer Sorgfalt, Disziplin und ein gutes Stück handwerklichen Stolz.“

Ian Sommerville, „Software Engineering“, Addison-Wesley 1987

Namenskonventionen

  1. Die Namen von Klassen, Methoden, Variablen usw. werden mit möglichst kurzen, aber aussagekräftigen Namen versehen (Sprechende Namen):
    zinssatz statt z
  2. Klassennamen beginnen immer mit einem Großbuchstaben und werden aus Substantiven gebildet. Besteht der Klassenname aus mehr als einem Wort, wird jedes einzelne Wort mit einem Großbuchstaben begonnen (UpperCamelCase):
    public class Beispiel {}
    public class ZweitesBeispiel {}
  3. Methodennamen werden aus Verben gebildet und beginnen mti einem Kleinbuchstaben. Besteht der Methodenname aus mehr als einem Wort, wird jedes weitere Wort nach dem ersten mit einem Großbuchstaben begonnen (camelCase):
    public void fuehreAus() {}
  4. Variablennamen werden nach dem gleichen Muster konstruiert wie Methodennamen: Sie beginnen mit einem Kleinbuchstaben. Folgende Wörter werden groß geschrieben (camelCase).

Neben diesen allgemein anerkannten Namenskonventionen sind die folgenden Konventionen sinnvoll:

  1. Parametern kann ein kleines p vorangestellt werden, um deutlich zu machen, dass es sich nicht um ein Attribut handelt:
    private int berechneSumme( pZahl1, pZahl2 ) {}
  2. Die Variablennamen i, j, k, l, m, n sollten nur als temporäre int-Variablen deklariert und zur Iteration genutzt werden.

Stylekonventionen

Das Layout des Quelltextes sollte übersichtlich sein, indem Einrückungen und Leerzeilen genutzt werden:

public class Beispiel
{
    private int zahl;

    public void setzeZahl( int pZahl )
    {
        zahl = pZahl;
    }
}

Der Quelltext sollte kommentiert werden, um die Lesbarkeit zu erhöhen.