Archief - REQUEST: documenteren opensource PHP5 framework

Hallo iedereen!

Ik zoek mensen die een klein beetje vrije tijd willen opofferen om een opensource PHP5 framework te testen/documenteren.

URL van het project:
http://sourceforge.net/projects/j4php/

Beschrijving van het project:
J is an object-oriented framework for PHP inspired by Struts, Ibatis, JUnit and Log4J. Its goal: to bring together the best patterns and solutions from the Java world, while still being simple and easy to use.

Bedankt!

Jeroen

Wat denk jij nu, dat mensen voor hun plezier wat extreem saai werk gaan verrichten?

Als je daar geen beloning aan vastkoppelt ga je niets vinden.

edit: of werk je aan dat framework en zoek je medewerkers (dan is het iets anders en heb ik je verkeerd verstaan)?

killgore,

Ik heb dat framework voor eigen gebruik gemaakt en ben er nog dagelijks mee bezig om het bij te schaven en uit te breiden.

Omdat ik al mn werk wou delen met de rest van de wereld, heb ik een project pagina aangemaakt op sourceforge.
Voor mezelf is al die documentatie niet nodig want ik weet perfect hoe alles in elkaar zit, die documentatie is voor mensen die het framework ook willen gebruiken.
Het is dus zoals je zegt in je edit, ik zoek mensen die het framework de moeite waard vinden, en er aan mee willen helpen (=tijdelijke/permanente medewerkers).

Op dit moment heeft het project geen documentatie, en aangezien documenteren niet mijn sterkste kant is, zoek ik daarbij hulp.
Bijdragen tot het project hoeft echt niet veel tijd in beslag te nemen, je doet waar je zelf zin in hebt, zolang het maar een meerwaarde geeft aan het geheel.

Ik hoop dat ik daarmee jou vraag heb beantwoord?

Jeroen

Waarom creëer je eigenlijk de basisdocumentatie niet met doxygen of phpDocumentor (of iets gelijkaardigs)? Dat vraagt niet echt veel extra tijd tijdens het coden.

Zonder die basisdocumentatie is het nl. lastig (en zo goed als onbegonnen werk) om tutorials ed meer te gaan schrijven voor code die iemand anders heeft ontwikkeld. Persoonlijk heb ik er momenteel echter geen tijd voor (te druk op het werk en met andere zaken die dringend eens online moeten komen).

BTW De CVS faciliteiten van SF gebruiken zou een pluspunt zijn als je wil dat er andere mensen gaan meewerken...

Om de één of andere reden is het er nooit van gekomen om zulk een tool te gebruiken. Waarschijnlijk door onervarenheid ivm het documenteren van php scripts.
Welke (gratis) tool raad je aan (voor php5)?

Momenteel werk ik alleen aan het project en is CVS niet echt nodig. Als er mensen mee willen doen, zet ik natuurlijk een CVS of SVN repository op.

Bedankt voor de feedback!

Jeroen

Zoals ik zei, phpDocumentor is wel handig voor PHP code, en voor algemeen gebruik is doxygen wel goed. Met - specifiek voor PHP - dus toch wel een lichte voorkeur voor de eerste. De tweede is uiteraard wel handig als je niet voor elke programmeertaal die je zou hanteren een nieuwe documentatie syntax wil gaan aanleren (gezond lui zijn maw ).

Bedankt voor de info, ik zal ze allebei eens uitproberen.

Jeroen

dJeez,

Ik heb vandaag wat met doxygen gespeeld, en het valt goed in de smaak.
Toch heb ik een paar vraagjes:
1) wat is het verschil tussen \namespace en \package?
2) is het mogelijk om de php klassen in de gegenereerde documentatie te ordenen volgens de package waartoe ze behoren? op die manier kan je zien welke klassen tot welke packages behoren en krijg je een duidelijker overzicht. ik heb reeds geprobeerd met \package, maar dit gaf enkel lege packages op. misschien kan jij me een voorbeeld geven hoe het moet?

Bedankt!

Jeroen

Voor de mensen die geinteresseerd zijn, J4PHP 0.6.2 bevat door doxygen gegenereerde documentatie!