Hallo zusammen,

ich bastel grade an einem kleinen PHP5-Framework um mich ein wenig in die OOP-Implementierung von PHP einzuarbeiten.

Da ich die Sachen beizeiten gerne der Öffentlichkeit zur Verfügung stellen möchte, frage ich mich welches System für die Dokumentation am besten geeignet sein könnte.

Ich habe da PHPDoc im Netz aufgetan, allerdings scheint die Installation nicht ganz trivial zu sein. Bevor ich mich also dort hineinstürze und meinen Apache quäle, würde ich gerne ein paar Meinungen von Euch hören.

Wie dokumentiert/kommentiert Ihr Eure PHP5-Klassen? Macht PHPDoc Sinn, oder gibt es noch was besseres?

Vielen Dank für Eure Antworten und viele Grüße

Torsten

Hier kannst Du dir noch ein paar anschauen, aber Erfahrung hab ich mit keinem diesen Tools,...

http://www.php-free.de/Entwicklungs-Tools/Dokumentation/more2.html

Gruß,

Markus

EDIT:

So rein vom durchklicken hat mir phpDoc am besten gefallen...

Ist wohl auch das einzige dieser Tools was noch weiterentwickelt wird.

Danke, rennt jetzt bei mir. Scheint aber durchaus noch ausbaufähig ... das Tool oder mein Verstand

Grüße,

Torsten

Hat sonst keiner Erfahrung mit PHPDoc? Ich bekomme ständig diese Meldung und weiß nicht warum er meine Klasse nicht erkennt.

PHPDoc is confused: module files must not contain classes. Doc will probably be broken, module gets ignored.

Für sachdienliche Hinweise wäre ich sehr dankbar .. ;-)

Grüße,

Torsten

Welches PHPDoc nutzt du? Dieses?

Wenn ja, damit hatte ich bislang nur Probleme. phpDocumentor ist da um Längen besser.

Genau, ich habe das Erstere. Danke für den Link, ich werde den Documentor morgen mal ausprobieren. PHPDoc macht wirklich nur Ärger ..

Grüße,

Torsten

@beebof:

Männoo ... jetzt hab ich den Documentor nochmal installiert und er parsed mir meine Files als prozedural. Wie kommt er dazu? Hast Du da eine Ahnung von?

Es kann sein, das ich was relevantes an meinen Klassen geändert habe, grundsätzlich denke ich das aber nicht. Also doch im Documentor? Mist! :confused:

Danke für Hilfe, das Forum auf der SourceForge ist nicht grade erquickend.

Viele Grüße,

Torsten

Hat sonst keiner Erfahrung mit PHPDoc? Ich bekomme ständig diese Meldung und weiß nicht warum er meine Klasse nicht erkennt.

Für sachdienliche Hinweise wäre ich sehr dankbar .. ;-)

Grüße,

Torsten

Ich habe auch schon gute Erfahrungen mit PHPDoc gemacht, ist aber schon länger her.

Kann es sein dass die Fehlermeldung damit zusammenhängt, dass Du in die Dateien, in der die Klasse definiert ist, auch noch normalen Code drin stehen hast? Das wäre nicht praktikabel, stört aber meines wissens PHP nicht.

Abhilfe wäre in diesem Fall jede Klasse in je eine eigene Datei zu schreiben, was meines Erachtens nach auch unbedingt empfehlenswert ist. Zusätzlich sollte man nur Abhängigkeiten zu anderen Klassen "includen" - nicht jedoch "normale" Skripts.

So, wen's interessiert: Es lag am Tool selbst. Apache runter- und wieder hochfahren, dann löppt datt wieder.

Grüße,

Torsten