nicht angemeldet
Hellihello
ausgelöst durch diesen Hineweis http://forum.de.selfhtml.org/archiv/2008/2/t166564/#m1086385 kam ich auf Doxygen und PHPDocumentor. PHPDocumentor schien mir nach ersten Recherchen die Wahl für PHP Code.
Wenn ich es recht kapiere, ist das an einer Syntax orientiert, die es beim Dokumnentieren von Java-Code gibt (JavaDoc).
1. ist festegelegt, in welchen Delimiteren der Kommentar zu stehen hat.
2. können "tags" benutzt werden, beginnend mit dem Klammeraffen.
Aufgefallen ist mir beim einem ersten Testlauf, dass im Kommentar viel Redundanz zum folgenden Code auftaucht. D.h., es wird nicht "nur" beschrieben, was da im folgenden zu geschehen hat und welchen Zweck man damit verfolgt, sondern Teile des Codes (Parameter, Klassenzugehörigkeit etc.) werden im Grunde im Kommentar wiederholt.
Das ist ja sicherlich auch logisch, weil der Documentor sich ja nur am Kommentar orientieren kann. Anderseits fragte ich mich, ob es da auch andere Ansätze einer Art "slim" Dokumentation gibt, bzw. auf welche Teile man beim Dokumentieren verzichten kann und auf welche besser nicht. Einleuchtend ist mir, dass insbesondere das in die Dokumentation gehört, was _nicht_ im Code steht.
Hat denn jemand hier Erfahrung mit dem PHPDocumentor gesammelt, oder folgt ihr in Kommentaren einer (anderen,gängigen) Konvention?
In der Forumssuche fand ich bezüglich PHPDocumentor in 2008/2007 nur einen unbeantworteten Post.
Dank und Gruß,