Generierung einer PHP-Dokumentation mit NetBeans unter Windows

PHPDoc ist eine Dokumentationslösung für PHP. Aus der Dokumentation können dann mit bspw. phpDocumentor später die Beschreibung für APIs oder die Entwicklerdokumentationen generiert werden. Auch einige IDEs wie NetBeans oder Zend Studio greifen auf diese Kommentare zurück und benutzen sie für die Codevervollständigung und Beschreibung.

Um eine solche Dokumentation mit NetBeans unter Windows mit dem phpDocumentor zu generieren, muss dieser zunächst installiert werden. Dafür ruft man am besten den Kommandozeileninterpreter von Windows auf (Start → Ausführen → „cmd“). Wichtig ist, dass das aktuelle Verzeichnis dem Benutzerverzeichnis entspricht (%HOMEPATH%). Hier gibt man dann den folgenden Befehl ein:

pear.bat install --alldeps PhpDocumentor

Dies setzt natürlich voraus, dass der Pfad zu PEAR (PHP Extension and Application Repository) in den Pfad-Variablen eingetragen ist. Der Befehl sorgt letztlich dafür, dass die benötigten Erweiterungen und deren Abhängigkeiten für den phpDocumentor heruntergeladen und eingerichtet werden.

Im Benutzerverzeichnis wird nun ein neues Verzeichnis „pear“ mit diversen Unterverzeichnissen und Dateien erstellt.

Damit NetBeans nun noch auf die Konfigurationsdatei unter „%HOMEPATH%\pear\data\PhpDocumentor\phpDocumentor.ini“ zugreifen kann muss eine kleine Änderung an der Datei phpdoc.bat vorgenommen werden. Die Datei liegt in dem PHP-Verzeichnis von Xampp. Damit das Skript die richtige Konfigurationsdatei findet, muss das Verzeichnis gewechselt werden. Dazu muss „CD %HOMEPATH%“ in der Datei eingetragen werden (am einfachsten am Anfang).

Bei Verwendung von PHP 5.3 sollte die php.ini Datei kontrolliert werden und ggf. angepasst werden. Wie unten gezeigt, sollte die folgende Zeile kein Kommentar sein:

"date.timezone = "Europe/Berlin"

Dieses findet man wenn man nach dem folgendem Block sucht:

[Date]
; Defines the default timezone used by the date functions
; http://php.net/date.timezone
date.timezone = "Europe/Berlin"

Nun kann man NetBeans starten und unter „Tools → Options → PHP → PhpDoc“ den Pfad auf seine „phpdoc.bat“ Datei setzen. Der Button zur Suche funktioniert nur, wenn der Pfad in der PATH-Variable hinterlegt ist. Optionen kann man direkt hinter der Datei eintragen wie: „-o HTML:frames:earthli“. Auch andere Formate für das spätere PhPDoc sind möglich.

Nun kann man mit einem Rechtsklick auf sein Projekt den Menüpunkt „Generate PhpDoc“ auswählen. Bei dem ersten Aufruf wird man zur Auswahl des Ziel-Verzeichnisses aufgefordert. Das Verzeichnis kann man über den Browser auswählen, muss dann jedoch die Backslashes in normale Slashes umwandeln („\“ → „/“), da andernfalls NetBeans kommentarlos die Generierung verweigert! So kann man nun schnell und ohne Umwege die PHP Dokumentation unter NetBeans 7.0 unter Windows ausführen.