Allgemeine Regeln zur Programmierung

 

  • Der Code sollte leicht lesbar sein (z.B. Einrückungen mit Tabulator von Blöcken, ...)
  • Kommentare sollten an geeigneten Stellen angebracht sein, sodass eine andere Person den Quellcode
    auch noch verstehen kann (es gilt ein geeignetes Quantum zu finden - zu viele Kommentare können den Quellcode auch wieder unübersichtlich machen). Ein einleitender Kommentar am Anfang der Datei, die deren Funktion beschreibt, ist sicher von Vorteil.
  • Variablen-Namen sollten für sich sprechen (z.B. $dateiName=”myfile.txt”; $Bewertung=1; etc.)
  • bei längeren Skripts sollten die einzelnen Teile auch in einzelnen Dateien landen (z.B. eintrag_loeschen.php, eintrag_hinzufuegen.php, eintrag_sortieren.php)
  • Oft ist eine Projektdokumentation angesagt – ist einige Zeit verstrichen, wird man ev. froh sein, eine solche angelegt zu haben, um sich im (eigenen) Projekt schnell wieder zurechtzufinden.

Ergänzende und vertiefende Module