Praxisumfrage: Inline-Dokumentation mit PHPDoc

**KinNeko** · 17.06.2002, 13:08

Benutzen ist der falsche Ausdruck..
..habe die Form halbwegs übernommen weil es ja auch offiziel unterstützt wird.
Aber die Doku ist so schlecht dass ich nicht mal weiss was es gibt.

Ausserdem scheint das Teil ein Adaption von Javadoc zu sein und weigert sich beharrlich meine nicht obektorientierte programmierung zu akzeptieren.
In der Api stehen danach mehr Warnings und Fehler (modul nicht deklariert).
Und er gibt für Array 750 Fehlermeldungen aus..wenn man das nicht beschreibt.

Ansonsten wird es nachher wohl sehr sinnvoll sein..auch wenn die Api nichts bringt so ist die inline-doku doch sehr einhaltlich..

..einfach todo, history, beschreibung in den kommentarblock pressen.

**Blaster** · 24.06.2002, 10:38

@KinNeko:

Ich möchte mich nochmal für deinen Beitrag bedanken.

Meine Erfahrungen sind nun folgende:

Die Doku von Samar, Stocker hat mit gelangt. Es hat jedenfalls alles wunderbar geklappt.

Während der Entwicklung hatte ich zwar den Eindruck mich nur mit Balast abzugeben. Doch beim kürzlichen 'Refactoring' eines alten Projektes weiß ich PHPDoc wieder zu schätzen. War auch bei Projekterweiterung zu empfehlen. Vor allem der Kunde sah genau, was Du gemacht hast.

Stimmt, wenn Du Dir die Doku stellenweise schenkst, nervt Das System mit hunderten von warings. Eine Default-Insert scheint es nicht zu geben.

Ob das System spinnt, wenn Du prozessdual arbeitest, kann ich leider auch nicht sagen. Ich bin auf reine OOP gedrillt, sonst funktioniert zum Bleistift ArgoUML ( http://argouml.tigris.org/ ) nicht, ein für uns wichtiger struktureller Einblick um XP ( http://www.xprogramming.org/ ) bei unseren Projekten mit den Kunden praktizieren zu können.

Das Du offensicht als Einziger ein Einblick hattest, ehrt Dich aber...

cu

Blaster

Praxisumfrage: Inline-Dokumentation mit PHPDoc