Thema: Heißer Tip: PHPDocumentor!

Hi zusammen!

Da hier ja ettliche Leute ihre PHP-Skripte objekt-orientiert schreiben und ich grad drüber gestolpert bin, wollte ich den PHP'lern mal diesen Link hier ans Herz legen:
http://phpdocu.sourceforge.net/

Um Euch die Arbeit zu ersparen, das Wie und Warum dieses Teils durchzulesen, hier ein kurzes Summary von mir:
Dieses Ding erlaubt es Euch, Eure Module, Packages und einzelne PHP-Files zu durchforsten und eine komplette API im Stil der Java-API von Sun als HTML oder PDF auszugeben.
Dabei muss man sich nur einen gewissen Kommentier-Stil angewöhnen, der aber auch in einem guten HOWTO auf der SF-Homepage erklärt ist.

Bsp.:
Eine Funktion wird so dokumentiert:
</font><blockquote><font size="1" face="Verdana, Helvetica, sans-serif">Code:</font><hr /><pre style="font-size:x-small; font-family: monospace;">/**
* function foo
* @param int $anzahl Anzahl der foos  default ist 1
* @return boolean 0 bei Misserfolg 1 bei Erfolg
*
*/
function foo ( $anzahl = 1 ) {
...some code here wink
}[/code]</blockquote><font size="2" face="Verdana, Helvetica, sans-serif">Ich hab das Ding grad irgendwie liebgewonnen, weil´s einem nen guten Teil der Aufbereitung der Dokumentation abnimmt denke ich.

Schönen Abend und viel Spa� beim Coden!

Tink/ Tommy

P.S. Das Ganze scheint vom JavaDOC "abgekupfert" zu sein, zumindest war das wohl vor PHP raus  <img border="0" title="" alt="[Lächeln]" src="images/icons/smile.gif" />

Beleidigungen sind die Argumente derer, die keine Argumente haben

2

Re: Heißer Tip: PHPDocumentor!

Hi Tink,

danke, das hört sich ganz nett an.
Werd es mir mal genauer anschauen, wenn ich wieder an was Größeres geh (mein CMS-Projekt liegt grad völlig brach *heul); Im Moment mach ich mehr oder weniger so Fitzelzeug, für das es keine API-Doku braucht (oder mal später).

Basti

3

Re: Heißer Tip: PHPDocumentor!

Hoi Basti  <img border="0" title="" alt="[Lächeln]" src="images/icons/smile.gif" />

Du hattest doch vor Kurzem hier mal Deine Session-Klasse vorgestellt wenn meine grauen Zellen mich nich schon wieder reinlegen.
Daran kann der Documentor doch schön getestet werden würd ich meinen  <img border="0" title="" alt="[Lächeln]" src="images/icons/smile.gif" />

Schönen Gru� aus München,

Tink/ Tommy

Beleidigungen sind die Argumente derer, die keine Argumente haben

4

Re: Heißer Tip: PHPDocumentor!

Hi Tink,

klar gäbe es genug, woran man das Ding testen könnte, aber ... später  <img border="0" title="" alt="[Lächeln]" src="images/icons/smile.gif" /> 

Basti

5

Re: Heißer Tip: PHPDocumentor!

[color="0022cc"]

Noch 'ne Ergänzung:

http://www.dclp-faq.de/q/q-php-doku-generator.html

Basti