gut lesbaren PHP Code zu erstellen ist eine Kunst für sich. Arbeitet man mit mehreren Entwicklern an einem Projekt, sind Coding Standards eigentlich unumgänglich. Die Frage die man sich also stellen muss ist, was ist nötig, um gut les- und wartbaren Quellcode zu erstellen ?
Ein paar Grundsätzliche Dinge sind z.B.
- Benutze beschreibende Variablen Namen. Es gibt keinen Grund warum ein Variablenname kürzer als 8 Zeichen sein sollte. Also lass keine Verben aus und erfinde deinen eigenen Dialekt. Anstatt $cmpnt benutze einfach $component. Du solltest eine IDE Benutzen die Code Vervollständigung unterstützt.
- Funktions- und Klassenmethodenamen sollten genauso beschreibend gewählt werden. Methoden die einen Boolean wert zurückgeben sollten das Präfix is oder has haben. Also z.B. isUser(), isAllowed(), hasChildren()
- Funktionen die einen Wert zurückliefern sollten ein get oder fetch als Präfix haben. Dies schützt vor syntaktischen Fehlern zwischen dem Aufruf einen Funktion und dem Zugriff auf eine Eigenschaft. Z.B. $user->comments als Eigenschaft und $user->comments() als Methodenname. Der Aufruft sollte eher $user->getComments() lauten.
Einige dich auf einen Coding Standard und halte dich dran. Coding Standards vereinheitlichen den Quellcode und machen ihn leichter verständlich. Man muss sich bei der Betrachtung des Quellcodes nicht noch zusätzlichen mit der Individuellen Benennung von Variablen etc. befassen.
Dokumentiere deine Funktionen und Klassen mit phpDoc. Mach es nicht für die automatisch generierte Dokumentation, das ist bloß ein schöner Nebeneffekt. Viel wichtiger ist, das es dir einerseits hilft, die Parameter sowie die erwarteten Typen, die möglichen Rückgabewerte sowie Exceptions während des Entwickelns zu erfassen, andererseits ist es einfacher deinen eigenen Quellcode wieder zu verstehen wenn du ihn lange nicht gesehen hast.
Mit Hilfe des PEAR Package PHP Code Sniffer kannst du deinen Code auf existierende Coding standards wie z.B. die Pear or Zend Standards prüfen.
Und der wohl beste Tipp ist, les den Code anderer Leute und schau ob dein Code noch schlechte Angewohnheiten besitzt.