Codekonventionen

Eine Codekonvention ist eine Übereinkunft unter Programmierern einen gewissen Stil beim Schreiben ihrer Programme einzuhalten. Über die Jahre hinweg haben sich in fast allen Programmiersprachen eine oder mehrere solcher Standards gebildet.

Verständlichkeit eines Algorithmus

Ein wichtiges Merkmal für einen Algorithmus ist die Möglichkeit für einen menschlichen Leser den Algorithmus lesen und verstehen zu können, obwohl er nicht in umgangssprachlicher Form vorliegt.

Als Beispiel sei folgender Algorithmus gegeben, der zwei Zahlen miteinander multipliziert, ohne explizit einen Multiplikationsoperator zu verwenden:

Eingabe: Zwei ganze Zahlen a und b
Ausgabe: Produkt aus a und b
Vorgehensweise:
    Initialisiere das Ergebnis mit 0
    Addiere a mal b auf das Ergebnis
    Gebe das Ergebnis zurück

Beispiel für eine schwer verständliche Formulierung des Algorithmus':

  public static int berechnen2(int a, int b){int erg=0;for(int i=0;i<a;i++){erg+=b;}return erg;}
  

Das gleiche Beispiel, lesbarer und mit Syntaxhighlighting hervorgehoben:

public static int berechnen(int a, int b)
  {
    int erg = 0;
    for(int i = 0; i<a ; i++)
    {
        erg += b;
    }
    return erg;
  }

Beide Programme führen das gleiche aus. Beide berechnen das Produkt von a und b, ohne eine Multiplikation durchzuführen. Sie addieren b a-mal auf eine Ergebnisvariablen auf, Genaueres s. Schleifen. Diese Variable wird zum Schluss zurückgegeben.