Zum Inhalt springen
View in the app

A better way to browse. Learn more.

Fachinformatiker.de

A full-screen app on your home screen with push notifications, badges and more.

To install this app on iOS and iPadOS
  1. Tap the Share icon in Safari
  2. Scroll the menu and tap Add to Home Screen.
  3. Tap Add in the top-right corner.
To install this app on Android
  1. Tap the 3-dot menu (⋮) in the top-right corner of the browser.
  2. Tap Add to Home screen or Install app.
  3. Confirm by tapping Install.

phpdoc, php:reflection... alternative ?

Empfohlene Antworten

Veröffentlicht

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

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...

Hallo Aiun, kann ich den Code zum Ausprbieren bekommen?

So etwas suche ich!

:uli

Viele Grüße

Lars

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.

Hallo Aiun,

danke, da bin ich mal gespannt!

viele Grüße

Lars

Archiv

Dieses Thema wurde archiviert und kann nicht mehr beantwortet werden.

Configure browser push notifications

Chrome (Android)
  1. Tap the lock icon next to the address bar.
  2. Tap Permissions → Notifications.
  3. Adjust your preference.
Chrome (Desktop)
  1. Click the padlock icon in the address bar.
  2. Select Site settings.
  3. Find Notifications and adjust your preference.