JSON-Schema-Extractor aus Quellcode: Difference between revisions
mNo edit summary |
m (→Beschreibung) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
== Beschreibung == |
== Beschreibung == |
||
Die Konfiguration von Simulationsprogrammen kann meistens mit einer Config-Datei vorgenommen werden. Diese Dateien können verschiedene Formate haben. Das vorliegende Simulationswerkzeug verwendet JSON-Dateien. Zusätzlich wird aus dem Quellcode mit Doxygen [http://www.stack.nl/~dimitri/doxygen/ |
Die Konfiguration von Simulationsprogrammen kann meistens mit einer Config-Datei vorgenommen werden. Diese Dateien können verschiedene Formate haben. Das vorliegende Simulationswerkzeug verwendet JSON-Dateien. Zusätzlich wird aus dem Quellcode mit Doxygen [http://www.stack.nl/~dimitri/doxygen/] eine Hilfeseite erzeugt die alle möglichen Eingabeparameter beschreibt. Um eine Config-Datei zu validieren kann eine Simulation gestartet werde, was zum Abbruch führt, falls sie nicht valide war. Für JSON gibt es Schemata [http://json-schema.org/] und Validatoren [http://www.jsonschemavalidator.net/], die eine JSON Datei auf die Validität gegen dieses Schema prüfen. Das Schema soll automatisch aus den Doxygen Annotationen zum Quellcode der Simulationssoftware erstellt werden. Existiert ein Schema, kann dieses verwenden werden um eine grafische Eingabemaske zu erzeugen [https://github.com/jdorn/json-editor]. |
||
== Ziel == |
== Ziel == |
||
Latest revision as of 10:16, 27 February 2017
JSON-Schema-Extractor aus Quellcode
Beschreibung
Die Konfiguration von Simulationsprogrammen kann meistens mit einer Config-Datei vorgenommen werden. Diese Dateien können verschiedene Formate haben. Das vorliegende Simulationswerkzeug verwendet JSON-Dateien. Zusätzlich wird aus dem Quellcode mit Doxygen [1] eine Hilfeseite erzeugt die alle möglichen Eingabeparameter beschreibt. Um eine Config-Datei zu validieren kann eine Simulation gestartet werde, was zum Abbruch führt, falls sie nicht valide war. Für JSON gibt es Schemata [2] und Validatoren [3], die eine JSON Datei auf die Validität gegen dieses Schema prüfen. Das Schema soll automatisch aus den Doxygen Annotationen zum Quellcode der Simulationssoftware erstellt werden. Existiert ein Schema, kann dieses verwenden werden um eine grafische Eingabemaske zu erzeugen [4].
Ziel
Implementierung eines Tools welches ein JSON-Schema für die Config-Datei aus dem Quellcode bzw. der Dokumentation erzeugt.
Anforderungen
- Python
- Doxygen
- C/C++
