PHP-Code mit Doxygen dokumentieren

Objektorientierter PHP-Quellcode ist klasse. Solange er gut dokumentiert ist. Mit dem Open Source Programm Doxygen ist das nun keine Schwierigkeit oder mühseelige Arbeit mehr. Denn Doxygen erzeugt auf Basis der Javadoc-Spezifikation vollautomatisch eine benutzerfreundliche Klassen-, Methoden- und Variablenübersicht eines PHP-Projektes; und zwar plattformunabhängig und im Gegensatz zu phppdoc verlässlich und ohne Abhängigkeiten.

Diese Anleitung erklärt kurz, wie man dabei vorzugehen hat:

1. Doxygen fürs passende Betriebssystem herunterladen, installieren und starten.
2. Neues Dokumentationsprojekt über den "Wizard" erzeugen.
3. Zuzüglich zum Projektnamen und Version auch den Quellcodepfad angeben. Den kann man auf Wunsch rekursiv durchsuchen lassen. Außerdem muss ein Ausgabeverzeichnis festgelegt werden, wohin doxygen seine Dokumentation schreiben soll.
   Hinweis: In der Experten-Einstellungen können über Masken und Filter auch Dateien und Verzeichnisse von der Dokumentation ausgeschlossen werden.
4. Im Reiter: Mode sollte Optimize for Java output eingestellt sein.
5. Im Reiter: Output ist es ratsam den Latex-Export erst einmal abzuschalten.
6. Hat man alle seine Einstellungen vorgenommen muss man das Arbeitsverzreichnis angeben (am besten das selbe Verzeichnis wie das Projektverzeichnis) und die Einstellungsdatei 'Doxyfile' speichern.
7. Mit Klick auf Start gehts los.

Nach wenigen Sekunden erhält man in dem angegebenen Ausgabeverzeichnis eine vollständige Dokumentation die sich bei Kunden und Kollegen sehen lassen kann, vorrausgesetzt man hat sich an der Syntax von Javadoc orientiert.

Obwohl wohl in Doxygen PHP-Unterstützung nirgends Erwähnung findet, ist das Ergebnis recht gut. Denn private Mitglieder werden von öffentlichen unterschieden, auch Konstanten und statische Variablen werden beachtet. Am Design und den teils etwas unglücklichen Ausgaben lässt sich mit Sicherheit zwar noch etwas feilen, aber jetzt ist eines schon sicher: Mit diesem Programm wird das Schreiben und vorallem Lesen von Quellcode wieder wesentlich mehr Spaß machen.

Wer sich gern selber davon überzeugen möchte. Für den habe ich hier mein Doxygen Testprojekt zum Herunterladen in einem ZIP-Archiv verpackt.