|
|
 |
Know-How:
PHP-Code strukturiert und dokumentiert
Sauberer Code
Artikel aus Internet Professionell Ausgabe 2/2006
Author:
Max Bold
Nur zu funktionieren ist für ein professionelles PHP-Skript zu wenig. Der Quellcode muss auch gut strukturiert und kommentiert sein. Nur so kann man professionellen Ansprüchen genügen.
Teamarbeit
Ob ein PHP-Programm funktioniert oder nicht, ist nur ein Kriterium für den Erfolg eines Programmierers. Auch wie das Ergebnis zustande gekommen ist und wie es sich einem dritten Betrachter präsentiert, ist von entscheidender Bedeutung. Die gilt vor allem für professionelle Applikationen und insbesondere auch für Open-Source-Projekte. Gerade hier geht es ja darum, dass die Community sich dieses Projekts annimmt und es gemeinsam weiterentwickelt und pflegt.
Auch kommerzielle PHP-Applikationen sind selten das Ergebnis eines engagierten Einzelkämpfers, sondern sie werden von Programmierteams gemeinsam entwickelt. Eine solche Arbeitsweise setzt jedoch voraus, dass Dritte den Code jederzeit verstehen und dort nahtlos weitermachen können, wo ein anderes Mitglied des Teams aufgehört hat. Damit ein solches Teamwork funktioniert, muss ein professioneller Programmierstil gepflegt werden. Verständlich, dass eine solche Anforderung der Todfeind jeglichen Individualismus beim Codieren ist.
Aber auch Einzelkämpfer sollten die berüchtigte, nur am Funktionalen interessierte Spaghetti-Methode beim PHP-Codieren tunlichst vermeiden. Selbst wenn ein so zusammengeschustertes Skript funktioniert, rächt sich dieser Programmierstil bitter, wenn es nach einiger Zeit ans Modifizieren oder Erweitern des Programms geht. Vielfach kennt sich ein Programmierer in solchen Situationen dann in seinem eigenen Code nicht mehr aus, und eine mühsame Neuprogrammierung oder ein dramatischer Anstieg von Errors sind die Folgen.
Bleibt die Frage, was ein sauberer Programmierstil in PHP ist. Eine reine Lehre, die ohne jeden Zweifel allgemein anerkannt ist, gibt es nicht, jedoch eine Menge Ansätze. Zum Beispiel gibt es für Beiträge zu Pear, dem PHP Extension and Application Repository, die Coding-Standards, ohne die nichts läuft. Hier werden bis ins Detail Einrückungen, Zeilenlängen, Namenskonventionen, Dateiformate und der Zwang zum Kommentieren des Codes festgelegt. Wer sich auf den Weg zu einem sauberen Programmierstil macht, kann die dort festgelegten Definitionen als hilfreiche Wegmarken zur Kenntnis nehmen.
Schwierig wird die Sache dadurch, dass PHP sehr kulant und nachsichtig ist, wenn es um funktionierenden Quellcode geht. Das heißt, ein PHP-Skript hat auch dann gute Chancen, zu funktionieren, wenn man sich um einen guten Stil keinen Deut schert. Allerdings sollte man die Toleranz von PHP nicht unbedingt bis zum äußersten ausreizen und sich um einen guten Stil bemühen. Die Beachtung der folgenden Regeln und Prinzipien kann dabei hilfreich sein.
> nächstes Kapitel
Kapitel:
Teamarbeit
| Typisierung
| Namen für Variablen, Funktionen und Klassen
| Gute Namen finden
| Verwendete Sprache
| Konstanten definieren
| Redundanten Code vermeiden
| Die Kommentare
| Etwas Kosmetik
|
 |
|