Kapitel 13. Code-Dokumentation

"Well-commented is, like beauty, in the eye of the beholder."

--http://c2.com/cgi/wiki?WellCommentedCode

Einleitung

Neben dem Testen (siehe Kapitel 4) wird auch die Dokumentation von Programmcode häufig vernachlässigt. Dabei ist diese gerade bei der auf Wiederverwendung ausgerichteten objektorientierten Programmierung wichtig: Ohne entsprechende Dokumentation ist es für den Verwender einer Klasse schwierig, diese korrekt einzusetzen.

Auf dem weltweit ersten PHP-Kongress im Oktober 2000 in Köln hat Ulf Wendel mit PHPDoc den ersten Ansatz für die PHP-Code-Dokumentation vorgestellt. Dieser basierte auf dem Java-Werkzeug JavaDoc. Die von Ulf Wendel eingeführten Tags (siehe Tabelle 13.1) bilden bis heute die Grundlage sämtlicher Werkzeuge für die Dokumentation von PHP-Quelltexten.