PHP-Anwendung/-Klassen dokumentieren
J.Hahn
- php
Hi allerseits,
ich möchte für ein größeres PHP-Projekt (welches u.a. aus ca. 30 Klassen- und ebensovielen Anwendungs-Dateien besteht) eine Dokumentation erstellen, die möglichst flexibel verwendbar sein soll (z.B. als HTML-Doku, als auch event. konvertierbar zu einem PDF). Eigentlich sollen es zwei Dokus werden: Einmal ein Handbuch für Anwender der Applikation und zum zweiten eine technische Dokumentation der Klassen für Programmierer.
Ich hatte schon phpDocumentor ausprobiert. Das Ding scheiterte allerdings schon an der Beschreibung der Methoden einer Klasse: Ich übergebe an eine Methode meist statt mehrerer Parameter, die sich mit @param beschreiben ließen, ein assoziatives Array mit den benötigten Methoden-Parametern (Schlüssel = Paramtername, Wert = Parameterwert). Hier konnte ich mit phpDocumentor keine sinnvolle Klassendokumentation erzeugen.
Daher meine Frage: Gibt es eine Software, mit welcher sich Dokumentationen - soweit möglich automatisch - für die Verwendung in verschiedenen Formaten erzeugen lassen?
Auf
http://www.prototypejs.org/api
ist die Doku z.B. sehr schön und übersichtlich gemacht und sie kann in verschiedenen Formaten heruntergeladen werden (PDF, Win-Hilfedati).
Danke für eure Hilfe und schöne Grüße, Josef
Hellihello
Ich hatte schon phpDocumentor ausprobiert.
Meine bisherige Recherche: das ist _die_ Dokumentation für PHP (s.a. Zend und Pear ?).
Dank und Gruß,
Hi,
Markdown scheint eine Alternative zu sein (zumindest ist die Prototype-Doku damit gemacht). Ist aber leider nur für Linux/Unix!?
http://daringfireball.net/projects/markdown/
Gruß, Josef
Hellihello
Markdown scheint eine Alternative zu sein (zumindest ist die Prototype-Doku damit gemacht). Ist aber leider nur für Linux/Unix!?
http://daringfireball.net/projects/markdown/
Also phpdocumentor ist doch irgendwie die "übertragung" von javadoc, oder? Und es läuft in php, also plattformübergreifend, so wie ich das verstanden habe.
Dank und Gruß,