ole-hartwig
.eu

Quellcode

Als erstes möchte ich einen Blick darauf werfen wie der Quellcode aussehen sollte und nach welchen Regeln ich diesen hier "gestalte". Man sollte sich von Anfang an daran gewöhnen den Quellcode immer nach einheitlichen Regeln zu schreiben. Denn ins besondere die Lesbarkeit eines Programmes hängt auch von er äußeren Form des Programms ab.

Ich habe hier einmal die Regeln zusammen gestellt nach denen ich üblicherweise meinen Quellcode schreibe.

  • Jede Anweisung beginnt in einer neuen Zeile.
  • Anweisungsteile von Kontrollanweisungen und Anweisungsfolgen werde zwischen den Klammern um eine konstante Anzahl von 2 - 4 (ich nutze meistens 2) Stellen (Leerzeichen) eingerückt. Die öffnenden und schließenden Klammern (oder beginn und end, etc.) werden nicht eingerückt.
  • Leerzeilen dienen der weiteren Gliederung des Programmtextes. Es empfiehlt sich, zusammengehörige Definitionen, Deklarationen oder Anweisungen auch optisch im Programmtext zusammenzufassen. Die einfachste Art ist die Trennung solcher Gruppen durch Leerzeilen. Es bietet sich an, einer solchen Gruppe zusammenfassenden Kommentar voranzustellen.
    • Die verschiedenen Definitions- und Deklarationsteile werden durch Leerzeilen getrennt.
    • Einzelne Funktions- bzw. Klassendeklarationen werden durch Leerzeilen von einander getrennt.
    • Anweisungsfolgen von mehr als ca. 10 Zeilen sollten durch Leerzeilen in Gruppen unterteilt werden.
  • Kommentare sind nützliche und notwendige Hilfsmittel zur Verbesserung der Lesbarkeit von Programmen. Sie sind wichtige Bestandteile von Programmen, und ihre Abwesenheit ist ein Qualitätsmangel.
    • Kommentare werden während der Programmierung eingefügt und nicht erst nachträglich ergänzt. Kommentare werden bei Änderungen angepasst.
    • Kommentare sind so zu plazieren, dass sie die Programmstruktur nicht verdecken, d.h. Kommentare werden so weit eingerückt wie die entsprechenden Anweisungen.
    • Kommentare werden wie folgt geschrieben:
    • // einzeiliger Kommentar
      • /* mehrzeiliger Kommentar */
  • Im Programmkopf wird die Aufgabe beschrieben, die das Programm löst. (Equivalentes gilt bei Klassen und Funktionen.)

Negativbeispiel

So sollte man seinen Quellcode nie, niemals, nicht aussehen lassen, PHP ist dies im Prinzip vollkommen egal, sollte aber jemande anderes oder man selbst nach einigen Wochen etwas ändern müssen braucht man unnötig lange für die Änderungen.

<?php
echo "Hallo \"Welt\"". $name ." - Mir geht es "; echo "gut"; function ausgabe ($wert) { echo $wert; }
?>

So sollte es sein:

<?php
echo "Hallo \"Welt\"";
echo $name; echo " - Mir geht es gut";
function ausgabe ($wert)  {
  echo $wert;
}
?>

Was die einzelnen Befehle genau machen und wofür welches Zeichen steht sehen wir auf den folgenden Seiten.

Nur so viel schon an dieser Stelle das ich die öffnende Klammer hinter die Funktionsdeklaration schreibe weicht von den meisten Skripten ab, viele schreiben diese in die nachfolgende Zeile!

Was die einzelnen Befehle genau machen und wofür welches Zeichen steht sehen wir auf den folgenden Seiten.
Nur so viel schon an dieser Stelle das ich die öffnende Klammer hinter die Funktionsdeklaration schreibe weicht von den meisten Skripten ab, viele schreiben diese in die nachfolgende Zeile!

Dailybooth

TOP