Heute möchte ich mal auf ein allgemeines Thema eingehen:
Richtlinien.
Zu Richtlinien gehört zum Beispiel: Einrückung, Kommentare schreiben und auch Variabelnamen.
Ich sehe es ganz oft bei meinen Azubis, dass diese Ihren Code ohne Kommentare und ohne Einrückung schreiben. Variabelnamen ordentlich setzten klappt bei denen schon ganz gut.
Wenn man Code ein paar Tage nicht angefasst hat, muss man immer erst schauen, was dieser eigentlich macht. Ohne Kommentare kann das ganz schön nervig sein!
Was macht diese Funktion nochmal? was ist in $xyz drin und warum teile ich das nun durch 3.5?
Man muss dann immer den halben Programmiercode durchschauen, um zu verstehen was man da selber oder jemand anderes gemacht hat.
Gerade wenn man mit verschiedenen Programmierern an einem Projekt arbeitet sollte man versuchen einheitlich zu kommentieren und einzurücken.
Variabelnamen können zum Verständnis des Codes extrem beitragen. Wenn ich meine Variable $itzliwutzli nenne, versteht kein Mensch was da gemeint ist. Heißt sie aber $arrObst, weiß ich, ich habe höchst wahrscheinlich einen Array mit Obstsorten.
Man kann Variabelnamen auf verschiedenste Weise benennen, man sollte es nur einheitlich machen
Ich nenne meine Variablen gerne nach ihrem Typ. Zum Beispiel:
ein Integer = $intAnzahlObst # dabei handelt es sich um einen Integer der die Anzahl von Obst beinhaltet.
$objBenutzer # hierbei handelt es sich um ein Object, welches einen Benutzer enthält.
$strBenutzername könnte ein String sein.
Funktion Namen sind genauso wichtig!
function getBenutzername() ist um einiges besser als function name()
function getBenutzernameById()
function setBenutzerPassword()
function loadBenutzer()
BTW: Ich benenne meine Variablen und Functions eigentlich immer auf Englisch.
Sieht sonst irgendwie komisch aus: getBenutzerDaten(); Besser finde ich getUserData();
Beim Einrücken gibt es auch verschiedene Möglichkeiten. Mancher macht die geschweifte klammer lieber in die selbe Zeile wie das If, andere lieber in die nächste Zeile.
Ich schreibe die Klammern in eine Zeile, das finde ich persönlich übersichtlicher.
Zum einrücken kann man Tabstopps oder Leerzeichen nehmen.
Beispiel:
# schlecht: if ($a == 1) { echo „a ist 1“; } else { echo „a ist“.$a; } # besser: /* Pruefen ob $a == 1 sonst $a ausgeben */ if ($a == 1) { echo „a ist 1“; } else { echo „a ist“.$a; } # oder /* Pruefen ob $a == 1 sonst $a ausgeben */ if ($a == 1) { echo „a ist 1“; } else { echo „a ist“.$a; }
Auf alle Möglichkeiten einzugehen wäre zu viel. Aber ich wollte euch einen Denkanstoß und kleine erste Hilfestellung geben.
Hier sind noch 2 sehr interessante Links zum Thema:
http://en.wikipedia.org/wiki/Indent_style
http://pear.php.net/manual/en/standards.php
Das ganze ist nicht nur auf PHP anzuwenden. Man sollte bei allem versuchen sauber zu arbeiten und einzurücken. Das gilt auch für CSS, Javascript, Perl, C, etc.