Dokumention mit phpDocumentor

Eine ausführliche Dokumentation des PHP-Codes ist unerlässlich, wenn andere Programmierer sich in umfangreichen Skripten zurecht finden sollen. Als eine sinnvolle Form der Dokumentation hat sich die direkte Kommentierung des Quellcodes erwiesen. Sofern man sich an bestimmte Richtlinien der Kommentierung hält, ist es mit Hilfe geeigneter Software ein Leichtes, aus diesen Kommentaren automatisch eine eigenständige Dokumentation zu generieren.
Auch für den Programmierer selbst ist eine solche Dokumentation hilfreich, um sich nach einer längeren Zeit wieder im Code zu orientieren.

Geeignete Software zur Generierung einer Dokumentation aus den Kommentaren im Skript sind zum Beispiel phpDocumentor oder doxygen.