Programmierregeln

Bei allen Programmieraufgaben sind grundsätzlich die unten aufgeführten Richtlinien einzuhalten.
Es werden keine Programme abgenommen, die diesen Ansprüchen nicht genügen. Bei theoretischen Hausaufgaben kann das Nicht-Einhalten dieser Regeln zu Punktabzug führen.

• Die Programme sind ausführlich kommentiert.
  Insbesondere ist auch jede Funktion kommentiert.
• Variablen müssen sinnvolle Namen haben.
  Nicht erlaubt ist das Durchbuchstabieren der Variablen von a an! Dadurch wird für uns und euch das Verstehen des Programms enorm erleichtert.
• Alle nichttrivialen Variablen müssen dokumentiert werden.
  Dies hat bei ihrer Deklaration zu erfolgen, da dies der einzige Punkte ist, den alle Variablen durchlaufen müssen, bei Übergabeparametern also im Funktionskopf. Und wenn eine Variable nicht einer allgemein gültigen Regel gehorcht, sondern ausgewählte Werte eine ganz bestimmte Information codieren, dann sind alle solchen Werte zu erläutern.
• Alle nichttrivialen Code-Fragmente müssen dokumentiert werden.
  Das gilt insbesondere für nicht triviale Abbruchbedingungen von Schleifen, wichtige Rechenschritte etc.
• Der Quelltext ist sinnvoll einzurücken.
  Ansonsten wird das Zuordnen von z.B. Schleifenanfängen und -enden sehr schwierig, worunter erfahrungsgemäß nicht nur derjenige leidet, der das Programm abnehmen soll, sondern auch ihr selbst.
• Funktionen sind kurz und übersichtlich.
  Als Richtwert gilt: Keine Funktion sollte länger als eine Bildschirmseite (70 Zeilen) sein (gerechnet bei einem Befehl pro Zeile und vielen Leerzeilen). Lieber mehr Funktionen als zu wenige einsetzen.
• Es dürfen keine nichttrivialen Programmsegmente in gleicher oder nur geringfügig veränderter Form mehrmals im gesamten Programm auftauchen.
  Das anscheinend vielgeliebte fünffache Kopieren des gleichen Codestücks mit anschließenden einfachen Änderungen ist hiermit verboten. Solch Code gehört in eigene Funktionen verfrachtet.

• Fehleingaben des Benutzers werden abgefangen und gemeldet.
  Es darf dabei keinerlei Fehlermeldung auf der Console (d.h. im xterm) erscheinen.

(Diese Programmierregeln wurden größtenteils von der CoMa Seite der TU Berlin übernommen)