phpDocumentor Webhosting

Was ist phpDocumentor

PhpDocumentor ist ein Dokumentationswerkzeug für die Scriptsprache PHP. Ähnlich wie Javadoc kann dieses Werkzeug von einer Kommandozeile oder einem Interface aus benutzt werden, um professionelle Dokumentationen des PHP-Quellcode zu erstellen. Das Tool gilt als Standardlösung für diesen Zweck. Es benutzt ein ausgedehntes Templatesystem, um die erzeugten Kommentare in lesbare und benutzbare Formate zu verwandeln. Darunter 15 bereits gestaltete HTML-Formate, PDF, Windows Helpfile und Docbook XML.

Außerdem ist es möglich eigene Templates zu gestalten. PphDocumentor wurde unter der LGPL veröffentlicht. Diese erlaubt die freie Verbreitung und Eingriffe in den Quellcode unter Wahrung des Copyrights. PhpDocumentor kann als eigene Anwendung installiert werden. Es ist aber auch fester Bestandteil der PHP Bibliothek PEAR (PHP Extension and Application Repository)

Historisches über phpDocumentor

Zu den namentlich bekannten Entwicklern von phpDocumentor gehören Joshua Eichorn, Greg Beaver. Eichorn veröffentlichte die Dokumentation für die Version 0.1.6. am 31.10.2000 auf Sourceforge. Danach erschienen zahlreiche Verbesserungen und weitere Releases. Das letzte trägt die Nummer 1.4.2. und stammt vom 31. März 2008. Unterstützt werden PHP 4.3 - 5.1. Für die Version 5.3. wurden auf Sourceforge Bugfixes veröffentlicht.

Was sind die Vorteile von phpDocumentor

PhpDocumentor ist lizenzfrei und über das Internet auf der gleichnamigen Projektseite erhältlich. Es ist eine Standalone-Lösung für die Scriptsprache PHP und somit alternativlos und gilt als Standardwerkzeug zur Dokumentation von PHP Quellcode, kennt sämtliche Elemente von PHP. PhpDoc arbeitet sehr schnell, hat ein Web- und Commandline-Interface, ist anpassbar, enthält einen Parser für Standard readme, changelog und faq-Dateien und fügt diese in die Dokumentation ein. PHP-Beispieldateien können direkt in der Dokumentation plaziert werden. Außerdem kann der Output über .ini-Files benutzerabhängig gesteuert werden (multiple output).