Home-Produkte-Testarea-Kontakt-Datenschutz-Aktualisiert: 07-May-2003
< Voriger Tag   Nächster Tag >

Mittwoch, 07. Mai 2003

phpDocumentor

Die Grundstruktur von 'ydTextToPHP.php' steht und es werden auch schon funktionsfähige Programme erzeugt.

Als nächstes kam ein Blick in phpDocumentor dran, um dazu passende phpDocs zu erzeugen. Im Prinzip arbeitet phpDocumentor weiterhin wie das alte phpdoc - es ist aber einiges hinzugekommen.

An der grundlegenden Struktur der Dokumentation mit @param usw. hat sich aber nichts geändert. Neu ist u.a. die Verbindung mit in DocBook geschriebenen Dokumenten, z.B. ein Tutorial. Wobei phpdoc-1.2.0rc2 hier nicht mit CDATA-Abschnitten zurechtkommt und somit die eigene Dokumentation nicht generieren kann. Ansonsten funktioniert es und ist für PEAR komplett durchgelaufen.

Schön auch die Unterstützung von Convertern plus Templates, um verschiedenste Dokumentationsformate erzeugen zu können - neben HTML liegen u.a. Dateien für CHM und PDF bei. Eine Dokumentation im Stil von php.net wird mit '-o HTML:Smarty:PHP' erzeugt.

Die -p (--pear) Option ist hilfreich, um Doks für Klassen zu generieren, die nach den Regeln des PEAR-Style-Guides geschrieben sind. '$_varname' wird so automatisch als private Variable erkannt, ohne dies extra über '@access private' angeben zu müssen.

Formatierungen innerhalb der DocBlocks sind mit ein paar HTML-Elementen (P, PRE, UL ...) oder auch in reinen ASCII mit der Erkennung von Absätzen durch Leerzeilen und von Listen durch '- Listenpunkt' und entsprechender Formatierung möglich.

Durch die Archivgröße von 2MB sieht das ganze zwar etwas beängstigend aus, ist aber leicht und problemlos zu benutzen.

[Direktlink]

< Voriger Tag   Nächster Tag >

  RSS V0.91

<Mai 2003 >
   01020304
05060708091011
12131415161718
19202122232425
262728293031 

Home-Produkte-Testarea-Kontakt-Datenschutz-Aktualisiert: 07-May-2003
(C) 2000-2018 by Sven Drieling