Software Dokumentation Software einer NICHT klassischen Programmiersprache

[IT-Biene]

Hallo Zusammen,

ich entwickle kleine Tools und Modul in einer ERP Software, diese hat eine ganz eigene Programmiersprache

und ist nicht mit einer klassischen Programmiersprache zu vergleichen.

Wir wollen trotzdem diese Tools und Module dokumentieren, man kann innerhalb des "Quellcodes"

schon kommentieren, was wir auch machen, aber das wars dann auch schon. Eine komplette Beschreibung

des Tools oder einzelnen Funktionen ist somit nicht möglich. Außerdem können mehrere Tools zueinander gehören

und da wäre auch schön, wenn man dies auch erfassen könnte.

Außerdem sollte es auch möglich sein, dort Versionen, Feature Requests und Bugs zu melden.

Gruß

IT-Biene

[flashpixx]

Du kannst Doxygen + ggf einen eigenen Parser verwenden. Andernfalls schreib Dir eben selbst einen Parser, der die Dokumentation extrahiert und z.B. mittels Extensible Stylesheet Language oder LaTeX in ein Dokument umwandelt. Mittels Welcome to MetaUML, UML for LaTeX/MetaPost , TikZ and PGF | TeXample.net oder DOT (GraphViz) kannst Du Graphiken erzeugen.

Featurerequest / Bug Referenzen können z.B. ebenso geparst und mittels Commit Referenz vermerkt werden, z.B. in dem man bei Git den Commit-Hash des Commits verwendet, dies kann über die Hooks realisiert werden.

Du liefert nur wenige Informationen, die die Möglichkeit einschränken. Dokumentationerzeugung bzw. Referenzierung auf Features / Issues geschieht anhand irgendwelcher Referenznummern, die im Quellcode durch den Entwickler abgelegt werden müssen. Diese müssen dann mittels Parser verarbeitet werden.