Coding Standards

Das Problem von unleserlichem Code kennt wahrscheinlich jeder. Ganz gleich, ob es der eigene Code ist, den man zum ersten Mal nach langer Zeit wieder bearbeiten muss, oder ob es fremder Code, die Probleme sind meist die selben: An Kommentaren wurde gespart, die Formatierungen scheinen willkürlich und vielen Stellen merkt man an, dass sie nachträglich hinzugefügt wurden.

Dabei ist es gar nicht so schwierig, auch für Menschen leicht lesbaren Code zu schreiben, man benötigt nur ein wenig Disziplin und einige Regeln. Im dieser Reihe will ich ein paar dieser Regeln vorstellen, mit deren Hilfe auch Anfänger in der Lage sind, ihre Code leserlich zu schreiben.

Coding Standards sind quasi das 1×1 des lesbaren Codes. Auch wenn alle anderen Regeln angewandt werden, ohne eine Einhaltung der eigenen Coding Standards bleibt der Code unleserlich. Dabei ist diese Regel auch die am einfachsten einzuhaltende, denn einmal an einen Coding Standard gewöhnt, wendet man ihn meist automatisch an.

Mehrere Zuweisungen lassen sich wesentlich einfacher vom Auge erfassen, wenn sie gleich weit eingerückt sind. Daher empfiehlt es sich, die Zuweisungen an der längsten Variable auszurichten.

$date         = '26.01.2011';
$numberOfDays = 365;
$actualYear   = 2010;

Eine Einhaltung der Coding Standards ist besonders bei den Kontrollstrukturen (Verzweigungen und Schleifen) wichtig, da hier die Lesbarkeit besonders gerne leidet. Ich persönlich habe für mich folgende Regeln festgelegt:

  • Vor der öffnenden Klammer ( steht ein Leerzeichen, aber nicht dahinter.
  • Nach der schließenden Klammer ) steht ein Leerzeichen, aber nicht davor.
  • Die öffnende geschwungene Klammer { steht in derselben Zeile, wie die schließende Klammer ).
  • Die schließende geschwungene Klammer } steht am Anfang einer neuen Zeile.
  • Nach der öffnenden geschwungenen Klammer { werden alle Zeilen bis zur schließenden geschwungenen Klammer } um vier Leerzeichen eingerückt.

Daraus ergeben sich dann folgende Beispiele:

foreach ($vars AS $value) {
doSomething($value);
}

while ($i < 10) { print $i; ++$i; } for ($i = 0; $i < 5; ++$i) { if ($i % 2 == 0) { print $i; } } do { something(++$i); } while ($i < 10); [/sourcecode]

Mit diesen Regeln kommt man natürlich nicht aus. Es gibt noch unzählige weitere Situationen, für die man weitere Regeln benötigt. Am einfachsten ist es meist, sich an einen der vorgefertigten Coding Standards zu halten. Einige prominente Beispiele:

Es ist natürlich niemand gezwungen, sich an einen dieser Coding Standards zu halten. Sie sollten eher als Vorschläge gesehen werden, die man befolgen oder nach den eigenen Bedürfnissen umgestalten kann. Viel wichtiger ist, sich während eines Projektes konsequent an die gewählten Coding Standards zu halten.
Denn wie eine gleichmäßige Handschrift so ist auch der gleich bleibend formatierte Quellcode viel angenehmer zu lesen 🙂

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind markiert *