[PHP] Dokumentation von Klassen

ice-breaker

return void
ID: 93995
L
27 April 2006
6.257
585
hi,
also da ich doch mich mal habe dazu überreden lassen in ner Gruppe mit Freunden zu programmeiren, müssen andere nun ja auch wissen wie seine meine PHP-Klassen verwenden.
Ich dachte da gleich an PhpDocumentor, bei genauerem Ansehen war das aber scheinbar eine schlechte Idee, da die Methoden der Klasse nur in der Übersicht der Klasse inkl. ihrer Infos dargestellt werden.
Gibt es ein anderes leichtes System, womit ich eine Doku wie bei PHP.net schreiben kann? weil so Beschreibungen und Samples zu jeder Methode können schonmal länger werden.
 
Zuletzt bearbeitet:
Hi,

ich bin mir nicht sicher, in wie Weit mein favorisiertes Projektmanagement-Tool da mitspielt, allerdings bietet es eine interne kleine doku mit changelog etc - zumindest als bessere ToDo-Liste hat es mir bis jetzt gute Dienste geleistet :)

Einfach mal schauen unter https://www.streber-pm.org/

Gruß
 
Hi,

ich bin mir nicht sicher, in wie Weit mein favorisiertes Projektmanagement-Tool da mitspielt, allerdings bietet es eine interne kleine doku mit changelog etc - zumindest als bessere ToDo-Liste hat es mir bis jetzt gute Dienste geleistet :)

Einfach mal schauen unter https://www.streber-pm.org/

Gruß

falls du das Wiki meinst, ne ich dachte an eine richtige Dokumentation. Sollte ja auch nicht in einer Software dann "festhängen" sondern als Doku mit der Klasse mitlieferbar sein.

aber Streber gefällt mir auch, war nen schöner Artikel im PHPMagazin :biggrin:
 
Du sagst es :)

Ansonsten eventuell https://www.phpdoc.de ? Das schaut mir auf den 1. Blick ganz nett aus, die Klassen-Dokus sind als html-files mitlieferbar (soweit ich das jetzt sehe) ;)

*hust*

ich wollte für jede methode eine einzelne seite haben und nicht alle auf einer seite geklatscht, denn wenn dann amche ich die erklärungen und Code-samples gleich schön ausführlich
 
Du sagst es :)

Ansonsten eventuell https://www.phpdoc.de ? Das schaut mir auf den 1. Blick ganz nett aus, die Klassen-Dokus sind als html-files mitlieferbar (soweit ich das jetzt sehe) ;)

Ich weiss nicht genau ob das Ganze nicht das Gleiche ist wie https://pear.php.net/package/PhpDocumentor, aber von den Versionsnummern wuerde ich sagen unterschiedlich, nur ich hab keine Demos Saples oder Aehnliches gefunden, aber kannst dir ja mal anschaun ...

Gruesse,
artemis
 
Ich weiss nicht genau ob das Ganze nicht das Gleiche ist wie https://pear.php.net/package/PhpDocumentor, aber von den Versionsnummern wuerde ich sagen unterschiedlich, nur ich hab keine Demos Saples oder Aehnliches gefunden, aber kannst dir ja mal anschaun ...

Gruesse,
artemis

den PHPDocumentor habe ich mir auch schon angesehen, die Demo auf Pear hat es geschafft für die verschiedenen Tags aber irgendwie auch geschafft einzelne Seiten anzulegen, hmm, muss ich mir das nochmal genau ansehen

Edit: ich will nur mal an den roten Reno-Poster bemerken, dass die MEIN POST ist und nicht deiner und ich hier machen und lassen kann was ich will :p