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 ![]()
}[/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" />