Die für jede Sprache geltenden Konventionen erleichtern das Einarbeiten in fremden oder eigenen Code. Dennoch gibt es keinen Zwang wie bei der Sprachsyntax, die Empfehlungen einzuhalten. Es wird immer eine freiwillige Leistung des Entwicklers oder des Teams bleiben, guten Code zu schreiben. Allerdings lohnt es, sich mit der hier aufgeführten Konvention zu befassen.

Dokumentations-Werkzeuge

Eine brauchbare Dokumentation ist Gold wert. Um das Dasein eines Entwicklers zu erleichtern, steht dazu inzwischen eine Vielzahl von Tools zur Verfügung, die es ermöglichen, eine Dokumentation in kürzester Zeit zu erstellen. Die Programme analysieren den Quellcode, entnehmen die Kommentierung und erstellen daraus eine fertige Dokumentation. Jedoch ist keine der Anwendungen in der Lage, die Arbeit komplett zu erledigen. Die resultierende Dokumentation kann nur so gut wie Ihre Vorarbeit sein.

Bei der Entwicklung von PHP-Anwendungen ist der Einsatz des PHPDocumentor [1] empfehlenswert. Das Programm stellt für die Erzeugung einer Dokumentation ein komfortables Web-Interface

Neben PHPDocumentor eignet sich auch Doxygen zur Erstellung professioneller und zeitgemäßer Dokumentationen.

zur Verfügung. Die erstellten Dokumentationen lassen sich auch online einsetzen. Als Alternative zum PHPDocumentor eignet sich ebenso Doxygen [2] von Dimitri van Heesch für diesen Zweck. Es wird unter anderem zur Dokumentation der Standard PHP-Library verwendet.

Performance versus Verständlichkeit

Immer wieder wird behauptet, dass gut lesbarer Code nicht performant sein kann. Obwohl die Aussage nicht ganz richtig ist, ist sie auch nicht falsch. Gut lesbarer Code ist auf jeden Fall länger und umfangreicher und daher auch etwas langsamer. Wenn aber nicht gerade an einem Performance-hungrigen Streaming-Server entwickelt wird oder umfangreiche Operationen durchgeführt werden, sollte sich der Performance-Unterschied nicht wesentlich bemerkbar machen. Gut verständlicher Code wird allerdings viel Zeit bei der Wartung und Erweiterung einer Anwendung sparen.

Fazit

In zahlreichen anderen Programmiersprachen ist eine einheitliche Syntax bereits selbstverständlich. In PHP ist dieser Stand der Entwicklung noch nicht erreicht. Ein Standard ist noch nicht festgelegt. Vielleicht können die aufgeführten Coderegeln aber dazu beitragen, dass es bald einen Standard geben wird und Entwickler auch in PHP-basierten Anwendungen verständliche Codestrukturen und Kommentare vorfinden.

Der Autor

Matthias Kannengiesser ist Dipl.-Informatiker und Projektmanager im IT-Bereich. Er berät seit mehreren Jahren namhafte Unternehmen und ist unter anderem als Dozent, Fachbuchautor und freier Mitarbeiter für Adobe Systems Incorporated tätig. Seit Jahren hält er Seminare, Workshops und Vorträge zu den Themen PHP und Datenbank-Development ab. Darüber hinaus verfasst er als freier Fachjournalist Artikel in diversen Magazinen. Im März erscheint die aktualisierte und erweiterte PHP 5/MySQL 5 – Masteredition (ISBN: 3-7723-7110-8).