php-documentor

[mstrauss]

Hallo zusammen,

dies ist kein Wunsch, sondern eine Frage. Besteht Interesse an einem Tutorial über die phpdocumentor-Bibliothek? Mit dieser lassen sich automatisiert APIs von geschriebenen PHP-Anwendungen erstellen. Vereinfacht die technische Dokumentation von Projekte ungemein.

Falls Interesse besteht, würde ich die Tage das Tutorial schreiben.

Gruß
Markus

[Basti]

Ist sicherlich ein interessantes Thema, auch wenn ich selbst von dieser Bibliothek bisher noch nichts gehört habe.

Wenn du Lust hast dann schreib doch einfach das Tutorial, ohne Nutzen wird es mit Sicherheit nicht sein
Ich habe kurz mal ein wenig recherchiert und die Bibliothek scheint wirklich nützlich zu sein ... und ein kompaktes Tutorial habe ich jetzt auch gerade nicht gefunden, insofern ist der wohl Bedarf ganz gut

[mstrauss]

Oki,

werd ich dann mal machen ...

die Lib wird vor allem bei wirklichen Applikationen verwendet, prominente Beispiel sind Joomla, Gallery2, Moodle, Log4PHP, PHPMailer, Seagull, etc.

Ist wirklich von Vorteil, wenn mehrere entwickeln aber auch für einen alleine. Ich hasse nichts mehr, als nach einem Jahr mich wieder in eine Source einzuarbeiten, um "mal eben" eine Anpassung vorzuenehmen. Da macht eine API schon Sinn.

[Basti]

Ja, das scheint wirklich sehr verbreitet zu sein. In der phpBB Sourcecode Documentation ist es mir gestern auch aufgefallen

[Manuel]

Mich würde es ebenfalls sehr interessieren, da ich bisher noch nicht damit gearbeitet hab!

[Dac-XP]

Mhh ich kannte bis vor kurzem nur JavaDoc. Seitdem ich das kannte, habe ich aber auch in PHP mit den ganzen JavaDoc-Kommentaren gearbeitet.
Und das ist wirklich nur jedem ernsthaftem Programmierer zu empfehlen, weil das den Durchblick enorm erhöht.

[Manuel]

Na dann warte mal bis Markus ein Tutorial geschrieben hat und dann kannst du ja sagen was du besser findest...
Und wenn JavaDoc in diesem Umfeld noch besser ist... => Tutorial *gg*

[Dac-XP]

Du hast mich glaube ich falsch verstanden Manuel.
PhpDoc ist fast das Selbe wie JavaDoc. Da ich meinen PHP-Quelltext immer im JavaDoc-Format kommentiert habe (nur so zur Übung) konnte ich (als ich von PhpDoc erfahren habe) problemlos die API verwenden.
Also ob PhpDoc oder JavaDoc ist egal, da sich die beiden sowieso gleichen.

[mstrauss]

@Dac: Richtig ... Javadoc = PHPDoc...genauso wie Log4J= Log4PHP ... warum immer alles neu erfinden.

Ok,ich sehe, Bedarf ist da, dann werde ich mich mal ransetzen.

Gruß
Markus

[Manuel]

Ah okay, ich dachte da bestünden Unterschiede in der Art der Kommentare usw. Dann weiss ich Bescheid.

[mstrauss]

Hallo Manuel,

ja, es bestehen auch Unterschiede. Das Gleich soll nur symbolisieren, was für Java das Javadoc ist, ist für PHP das PHPDoc ...

Grüße
Markus

[mstrauss]

Habe es doch tatsächlich geschafft, das Tutorial endlich zu schreiben. Ist aktuell in der Prüfung. Bin auf Feedback gespannt

Gruß
Markus

[Manuel]

*g* Hat immerhin fast 1 Jahr gedauert
Aber habs direkt mal überflogen. Ich denke Basti schaut sich das dann näher an wenn er Zeit hat. Ist ja zum Glück nicht ewig lang, aber sehr interessant!

Danke dir dafür!

[mstrauss]

ja ich weiss, is peinlich ... aber kundenprojekte gehen vor ... deswegen ist meine webseite auch immer noch nur ein impressum

[Basti]

Ich werde es mir in den nächsten Tagen auf jeden Fall anschauen, einen kurzen Blick habe ich gestern schon darauf geworfen.

Für mich ist es aber auch etwas neues. Ich bin an dem Thema jedoch brennend interessiert, da mir der php-documentor bei der Dokumentation meines kommenden CMS behilflich sein könnte.