PhpStorm 2016: Einbinden von phpDocumentor

Dokumentation von großen Softwareprojekten ist ein leidiges, aber nicht zu vernachlässigendes Thema. Bedauerlicherweise unterstützt die aktuelle Version von PhpStorm (2016) derzeit nur phpDoc Befehle für die Auszeichnung von Codestellen aber über kein eigenes Werkzeug um diese phpDocs auch zu erzeugen.

PhpStorm erlaubt jedoch die Einbindung externer Tools wie phpDocumentor. Dieses kostenlose und einfach einzubindende Werkzeug erzeugt umfangreiche und professionelle Dokumentationen eures Quellcodes. Vorausgesetzt, dass dieser auch entsprechend formatiert ist.

1. Download

Download des Tarballs (.tgz) – nicht des Source-Code – von phpDocumentor (auf GitHub). Alternativ könne ihr auch PEAR verwenden. Die Anleitung hierfür findet ihr auf der Herstellerseite von phpDocumentor.

Nach dem Download entpackt ihr das Archiv in ein Verzeichnis eurer Wahl (z. B. C:\phpDocumentor).

2. PhpStorm Konfiguration

In PhpStorm unter Preferences -> Tools -> External Tools fügen wir ein neues Tool hinzu. Die Felder füllt ihr wie in Abbildung 1 aus. Ich verwende hier die PHP.exe von Xampp, ihr könnt aber auch eine andere verwenden.

Tool Settings

PhpStorm Settings

Abbildung 1 – PhpStorm Settings


1.Program: Pfad zur php.exe
2. Parameters: Aufrufparameter der phpdoc Binary


Zu 2: Der 1. Teil ist der Pfad zum bin Verzeichnis in phpDocumentor. Der 2. Teil der Pfad zu eurem Projekt und der 3. Pfad zeigt auf das Ausgabeverzeichnis in das Ihr eure Dokumentation speichern wollt. Mehr Infos zu den Parametern findet Ihr hier.

3. Working Directory: Arbeitsverzeichnis (wird automatisch gesetzt)

Nachdem phpDocumentor eingerichtet ist, kann die Dokumentationserzeugung über das Manü unter Tools -> External Tools -> phpDocumentor aufgerufen werden.

Abbildung 2 – Konsolenausgabe

3. Die erzeugte Dokumentation

phpDocumentor erzeugt in eurem Ausgabeverzeichnis HTML-Dateien.

Abbildung 3 – phpDocumentor Ergebnis

Add Comment