Artikel

Das Open-Source-Tool “PHP Documentor” gilt als Defacto-Standard für die Erstellung von Entwickler-Dokumentation bei PHP-Projekten.

Für wohl jede Programmiersprache gibt es das passende Dokumentations-Tool. Im Falle von PHP ist dies das quelloffene und kostenlose Programm PHP Documentor. Wie bei den meisten Lösungen in diesem Bereich üblich ist – zum Beispiel JavaDoc für Java-Entwickler oder Doxygen für Objective-C-Projekte – werden auch bei PHP Documentor spezielle Tags im Code verwendet, um die API-Dokumentation automatisch zu generieren. Die Syntax für die Dokumentationskommentare im Quelltext ist stark an dem JavaDoc-Standard angelehnt und unter dem so genannten PHPDoc-Standard zusammengefasst. So lassen sich mit dem Tag “@param” auch im PHP-Code Eingabeparameter dokumentieren. Weitere Formatierungsanweisungen, die Java-Entwicklern sicherlich bekannt sind, sind “@author”, “@return” und “@deprecated”, um nur einige Beispiele zu nennen.

Als fester Bestandteil der populären “Pear”-Bibliothek (“PHP Extension and Application Repository”), die zahlreiche Erweiterungsmodule für PHP zusammenfasst, ist PHP Documentor selbst in PHP geschrieben. Unterstützt werden sowohl PHP4 (ab Version 4.3) als auch PHP5. Entwickler haben die Wahl, das Programm entweder auf der Kommandozeile zu bedienen oder über eine Web-basierende Anwendung, die im Standard-Distributionspaket mitgeliefert wird. Was die Formatierung der erstellten Dokumentation angeht, unterstützt das Tool viele gängige Formate, so zum Beispiel Html, PDF und CHM.

Fazit

Zu einer guten Software gehört immer auch eine gute Code-Dokumentation dazu. PHP Documentor bietet sich als eine der besten Alternativen für Web-Programmierer, die mit dieser Skriptsprache arbeiten.