phpDocumentor bei SVN commit starten

Was ist Code ohne Dokumentation? Genau: total daneben.

Zum Glück gibt es ja praktische Helfer wie phpDocumentor, um aus Kommentaren eine richtig anständige Dokumentation zu zaubern. Aber das verdammte Ding nach jedem SVN commit anzustoßen ist auf Dauer ganz schön nervig…

Abhilfe verspricht der post-commit hook. In dem Wurzelverzeichnis jedes SVN Repositorys befindet sich ein Verzeichnis namens hooks. Dort können beliebige ausführbare Dateien hinterlegt werden, die je nach deren Dateinamen zu einem bestimmten Zeitpunkt ausgeführt werden (Beispiele / Templates sind bereits in dem Verzeichnis enthalten).
Um phpDocumentor nach einem erfolgreichen SVN commit zu starten kann man ein Bash-script verwenden, indem man diesem den Dateinamen post-commit verpasst und das Executebit setzt (chmod +x foo).

Der Ablauf im Script ist dann wie folgt:
1. SVN checkout anwerfen
2. phpdoc -d anwerfen
3. Quellcode löschen (bei Bedarf)

Das Script bekommt bei seinem Aufruf 2 Argumente: den absoluten Pfad zum betroffenen Repository sowie die Reversion nach dem commit.

Besonders praktisch finde ich daran die Möglichkeit den Quelltext zusammen mit der entsprechenden Dokumentation im Intranet zugänglich zu machen.

Ein Gedanke zu „phpDocumentor bei SVN commit starten

  1. Peter (2 comments)

    Beschäftige mich auch gerade etwas mit php Basics und Dokumentation. Hab jetzt auch mal in phpDocumentor reingeschaut. Auf den ersten Blick sieht das ja genauso umfangreich wie php selbst aus. Da muss man denke ich auch einge Zeit investieren um das sinnvoll nutzen zu können.

Kommentare sind geschlossen.