Zum Inhalt springen

Empfohlene Beiträge

Geschrieben

hu,

ich suche derzeit Tools um Dokumentationen eines PHP-Frameworks zu erstellen.

Das Tool sollte PHP-Code analysieren und daraus "einfachen" xml-Code generieren, den ich dann für verschiedene zwecke, z.B. Einbindung in die Website des Frameworks nutzen kann.

getestet habe ich:

phpdocumentor

Problem: die meisten Formate sind full-html, framed oder alles inline. das XML-Format docbook ist nicht gerade gut zu parsen und in meinem Beispiel waren es dateien je methode, anstatt datei je Klasse

dann die php reflection API

Problem: die API gibt nur informationen über klassen die bereits geparsed sind, was dazu geführt hat, das der Code auch ausgeführt wird. (in einigen Dateien stehen oben aufrufe drin, die Klassenabhängigkeiten auflösen)

ergo, komme ich auch mit der reflection api nicht weiter.

Gibt es andere Tools die ihr empfehlen könnt, bevor ich wieder das rad ein 3. mal entwickeln muss ;) ?

danke

Geschrieben

nach einiger weiteren Suche habe ich nun eigene Klassen entwickelt um Dokumentationsblöcke und Klassen zu parsen, falls mal jemand vor dem gleichen Problem steht: fragen.

Die Klassen parsen bestimmte marker / schlüsselwörter (class, function /** ....)

und generieren XML-Dateien um die Klassen zu beschreiben. Die wiederrum können dann in Webseiten eingebunden werden um die Dokumentation darzustellen wie immer gewünscht.

  • 1 Monat später...
Geschrieben

kein Problem, schicke ich dir heute Abend, die Website für das Sphere-Framework ist leider noch nicht fertig.

Es gibt 1 Helper-Klasse die aus code XML-Dateien (mit Tags wie "class", "package", "method" unsw.) generiert. Natürlich kannst du nach dem Parsen auch andere Formate erstellen oder die Daten anders nutzen.

Ich generiere immer XML Dateien und verwende dann eine View / SimpleXML um das ganze darzustellen.

Erstelle ein Benutzerkonto oder melde Dich an, um zu kommentieren

Du musst ein Benutzerkonto haben, um einen Kommentar verfassen zu können

Benutzerkonto erstellen

Neues Benutzerkonto für unsere Community erstellen. Es ist einfach!

Neues Benutzerkonto erstellen

Anmelden

Du hast bereits ein Benutzerkonto? Melde Dich hier an.

Jetzt anmelden

Fachinformatiker.de, 2024 by SE Internet Services

fidelogo_small.png

Schicke uns eine Nachricht!

Fachinformatiker.de ist die größte IT-Community
rund um Ausbildung, Job, Weiterbildung für IT-Fachkräfte.

Fachinformatiker.de App

Download on the App Store
Get it on Google Play

Kontakt

Hier werben?
Oder sende eine E-Mail an

Social media u. feeds

Jobboard für Fachinformatiker und IT-Fachkräfte

×
×
  • Neu erstellen...