Mit wenig Aufwand kann man mit Hilfe des Tools PhpDocumentor automatisch eine Dokumentation des kompletten eigenen Quelltextes anfertigen lassen. Es müssen nur einige Standards beim Kommentieren eingehalten werden.

Eine Dokumentation des Quelltextes lohnt sich umso mehr, je größer ein Projekt ist. Denn hat man erst einmal zehn oder zwanzig Dateien mit Klassen und Funktionen, wird es sehr schnell unübersichtlich. Möglicherweise wissen Sie zu einem späteren Zeitpunkt nicht einmal mehr, in welcher Datei eine Methode oder Variable überhaupt steckt.

Der PhpDocumentor hilft an dieser Stelle. Das als Open Source veröffentlichte Programmpaket durchsucht PHP-Dateien nach Klassen, Funktionen und Kommentaren. So entsteht im Handumdrehen eine Übersicht über das komplette Programmierprojekt.