PHP coding guidelines
Welcher Programmierer kennt es nicht:
Man ist gerade dabei die Software eines anderen Entwicklers zu überarbeiten, aber man versteht rein gar nicht, was der andere Entwickler da programmiert hat. Dies kann viele Ursachen haben:
- Der Quelltext ist nicht oder nur dürftig kommentiert.
- Die Variablen- und/oder Funktionsbezeichnungen sind irreführend oder nicht verständlich.
- Man weiß nicht, wo ein bestimmter Abschnitt anfängt oder aufhört.
- Man weiß nicht, wo eine bestimmte Funktion herkommt, da auch am Skriptanfang keine weitere Datei includiert wird bzw. wenn man objektorientiert programmiert, findet man in der Mutterklasse keine solche Funktion.
Die Liste ließe sich glaub ich noch ewig weiterführen.
Wie gut, dass die Zend Framework-Entwickler diese Problematik auch hatten bzw. von dieser Problematik wissen und deshalb gleich den Zend Framework PHP Code Standard mit in die Dokumentation aufgenommen haben, der sehr detailliert beschreibt, wie man programmieren sollte.
Zend ist dabei aber nicht allein auf weiter Flur. Auch PEAR, Typo3, Wordpress, phpbb, etc. haben eigene Coding Guidelines veröffentlicht, die sehr genau beschreiben, wie man z.B.
- eine PHP-Datei optimal formatiert
- Klassen, Funktionen, Schleifen, Variablen, etc. richtig deklariert
- seinen Code verständlich dokumentiert (Stichwort phpDoc)
- etc.
Fazit:
Es lohnt sich einen Blick auf diese Richtlinien zu werfen und sich dann für diese zu entscheiden, die am Besten zu einem selbst passt. Wenn einem die oben genannten Guidelines nicht gefallen, kann man immer noch selbst solche Richtlinien definieren. Ohne Richtlinien programmieren geht zwar auch, aber man tut sich selbst und anderen Programmieren einen Gefallen, wenn man sich an manche Richtlinien hält.
abgelegt unter Allgemein
Kommentare
Schreibe einen Kommentar
-
-
Über zf-blog.de
zf-blog.de beschäftigt sich mit dem Zend Framework sowie der Webentwicklung mit PHP, mySQL und allen dazugehöhrenden Technologien.
-
Buchempfehlung
-
Links
