Technische Dokumentation und Klassenreferenz

Die technische dbXapp-Dokumentation verbindet Architekturhinweise, Entwicklerleitfäden und eine automatisch aus dem aktuellen PHP-Quellcode erzeugte Klassenreferenz.

Dokumentation für Entwicklung, Wartung und Erweiterung

Unter doku.dbxapp.de wird die technische Referenz der Plattform bereitgestellt. Sie richtet sich an Entwickler, Administratoren und technische Projektverantwortliche, die den Aufbau von dbXapp nachvollziehen, vorhandene Funktionen verwenden oder eigene Module systemkonform erweitern möchten.

Die Dokumentation beschreibt die zentralen Bausteine wie dbxDB, dbxTPL, dbxForm, dbxReport, Prozesse, Workflows, Mehrsprachigkeit, CMS und Cache. Ergänzend stellt die Klassenreferenz Namespaces, Klassen, Methoden, Eigenschaften, Dateien und den zugehörigen PHP-Quellcode strukturiert und durchsuchbar dar.

Technische Dokumentation öffnen

Wie die Dokumentation erstellt wird

Die Referenz wird mit Doxygen direkt aus dem jeweils aktuellen lokalen Quellstand erzeugt. Berücksichtigt werden die PHP-Kernelklassen, Module, Namespaces, öffentliche und interne Methoden sowie die zusammengefassten Entwicklerhandbücher. Dadurch bleibt die Dokumentation eng mit dem tatsächlich eingesetzten Programmstand verbunden.

1. Kommentare und PHPDoc-Hinweise werden direkt an den relevanten Klassen und Methoden gepflegt.
2. Die übergeordneten Handbücher dokumentieren Architektur, Entwicklungsregeln, Kernel, Konfiguration, Mehrsprachigkeit und CMS.
3. Das Build-Skript dbxapp-docs/build-docs.ps1 entfernt alte Ausgabedateien und erzeugt die HTML- und XML-Referenz neu.
4. Die fertige Website liegt anschließend unter dbxapp-docs/generated/html und kann vollständig auf den Webspace von doku.dbxapp.de übertragen werden.

Verwendung der Referenz

Über die Navigation können Entwickler gezielt nach Klassen, Namespaces und Quelldateien suchen. Die Volltextsuche findet Klassen- und Methodennamen sowie wichtige Begriffe. Verweise zwischen Methoden und Quellcode erleichtern es, bestehende Lösungswege zu verstehen, bevor neue Logik entwickelt wird.

Für eine neue Version wird die Dokumentation nach relevanten Änderungen erneut gebaut und der komplette Inhalt des HTML-Ausgabeverzeichnisses auf https://doku.dbxapp.de aktualisiert. So bleibt die veröffentlichte technische Dokumentation nachvollziehbar und entspricht dem aktuellen Stand der Plattform.

Eine gemeinsame Grundlage für Menschen und Entwicklungswerkzeuge

Die Dokumentation dient nicht nur als Nachschlagewerk. Sie hält die verbindlichen dbXapp-Prinzipien fest: Fachlichkeit bleibt im Modul, der Kernel wird über seine vorgesehenen Klassen genutzt, Templates enthalten die Struktur und neue Funktionen fügen sich in die vorhandenen Daten-, Formular-, Report- und Clientmechanismen ein. Das reduziert Sonderlösungen und erleichtert Einarbeitung, Wartung und Qualitätssicherung.