Variablen

PhpDocumentator

Bei Variablen innerhalb von Klassen informiert PhpDocumentor auf Wunsch über den Typ von Variablen – zumindest über den Typ, den sich der Programmierer wünscht. Dazu allerdings ist ein spezielles Tag notwendig. Und das sieht folgendermaßen aus:


/**

* @var string Überschrift

*/

var $strHeadline


Den Namen der Variablen geben Sie im Kommentar nicht mit an. Allerdings wird es unübersichtlich, wenn man 20 Variablen deklariert – und dazu 80 Zeilen Quelltext braucht. Auf dieses Feature kann man zu Gunsten einer eindeutigen Schreibweise der Variablen notfalls verzichten.

Zusätzlich unterstützt PhpDocumentor Verknüpfungen und Querverweise zu anderen Seiten in der Dokumentation. Sie dürfen auch Versionsnummern oder Programmbeispiele mit in die Dokumentation aufnehmen. Weiterhin bindet das Programm Docbook-konforme Dateien als Tutorials ein. So können Sie zu Ihrer PHP-Applikation umfangreiche Tutorials erzeugen und anschließend als HTML-Seiten speichern.

Das Tool PhpDocumentor ist ein Muss für alle PHP-Profis. Sie können es kostenlos von der Seite www.phpdoc.org herunterladen.