phpDocumentor
Aus php bar
phpDocumentor ist eine Dokumentationsgenerator für PHP, der aus speziellen Kommentaren im Quelltext automatisch Dokumentationsdateien erstellt. Die Annotationen entsprechen überwiegend denen von Javadoc.
phpDocumentor kann von der Kommandozeile aus oder über eine Weboberfläche zur Erstellung von Dokumentationen benutzt werden. Dabei verknüpft phpDocumentor die Dokumentation und erstellt auf Wunsch auch farblich hervorgehobenen Quelltext. Dazu greift phpDocumentor auf eines der 15 mitgelieferten Smarty-Vorlagen zu. Mögliche Ausgabeformate sind HTML, PDF, Windows Hilfedateien (CHM) und Docbook XML. Auch das Erstellen eigener Vorlagen ist möglich.
Inhaltsverzeichnis |
Installation
Installation über PEAR
Die Installation über PEAR ist einfach:
$ pear install pear/phpdocumentor
Manuelle Installation
Die aktuelle Version herunterladen und in ein beliebiges Verzeichnis entpacken.
Benutzung
$ phpdoc -d <quell_verzeichnis> -t <ziel_verzeichnis>
Für weitere Parameter siehe:
$ phpdoc -h
Beispiel
1 /** 2 * Ein Buch der Bücherei 3 * 4 * @author Max Mustermann <max@mustermann.com> 5 */ 6 class Buch 7 { 8 /** 9 * Titel des Buches 10 * @var String 11 */ 12 private $titel; 13 14 /** 15 * ISBN des Buches 16 * @var int 17 */ 18 private $isbn; 19 20 /** 21 * Standardkonsturktur 22 */ 23 __construct() 24 { 25 } 26 27 /** 28 * Setzt den Titel des Buches 29 * @param string $titel Neuer Titel 30 */ 31 public function setTitel($titel) 32 { 33 $this->titel = $titel; 34 } 35 36 /** 37 * Gibt den Titel des Buches zurück 38 * @return string Titel des Buches 39 */ 40 public function getTitel() 41 { 42 return $this->titel; 43 } 44 }
Links
- Offizielle Webseite (englisch)
- Handbuch (englisch)
