Dokumentation

Aus meiner Langeweile heraus habe ich mich nun heute mal mit dem Thema Dokumentation beschäftigt. Die phpDoc verwende ich zwar schon länger, allerdings ging es nun um die Frage, mit welchem Tool ich mir den nun die Dokumentation generieren lassen werde.

Die Kandidaten sond hierbei wohl phpDocumentor und Doxygen.

phpDocumentor hat den Vorteil, dass es explizit auf PHP abgestimmt ist und ich die Community damit unterstützen würde. Allerdings ist der Funktionsumfang von Doxygen größer und man sagt ihm nach, dass es einfach ausgereifter wäre.

Massgeblich für meine Entscheidung (vorerst) war dann die Integration in PDT: Diese geht mittels Plugin nur bei Doxygen. Daher werde ich erstmal mein Glück damit versuchen.

Ich habe also Eclox installiert und die gröbsten Einstellungen getroffen. Dazu gehörten unter anderem Projektname sowie Version und die zu dokumentierenden Ressourcen. Hierbei habe ich mich auf die Verzeichnisse für “Controller”, “Models”, “Plugins”, “Tests” und “Helper” beschränkt. Diese werden jedoch rekursiv behandelt. Der Grund liegt darin, dass ich hier die interessanten Klassen erwarte.

Leider klappt bisher nicht alles, wie ich das gerne hätte. Zum einen werden nicht alle phpDoc-Tags unterstützt, zum Beispiel @licence und die UML Diagramme werden erst garnicht generiert, obwohl ich dies aktiviert habe.

Ich werde trotzdem weiterhin dran bleiben und berichten.