Dieses Modul
ist weniger für die direkte Wiederverwendung in anderen Modulen
gedacht, als vielmehr als Entwicklungswerkzeug, um Module mit Hilfe
ihrer Quellcode-Kommentare zu dokumentieren. Alle Kommentare, die
sich zwischen den Tags <DOKU> und </DOKU> befinden werden
in ein HTML-Dokument geschrieben, welches den Dateinamen des Moduls
(inkl. der Endung ".mod") und der Erweiterung ".htm" bekommt. Der Aufruf auf Kommandozeilenebene sieht exemplarisch wie folgt aus: /tdbengine/tdbengine doku.prg -cwin -smeinmodul.mod -ddoku
Wurde
kein "-d Paramter" als Zielverzeichnis übergeben, so wird ein
Unterverzeichnis ./doku/ angelegt und als Zielpfad verwendet.
Das Ergebnis ist eine Datei namens meinmodul.mod.htm Das Doku-Modul unterscheidet bisher 2 Vorkommensarten der <Doku>-Tags, nämlich a.) Innerhalb eines PROCEDURe-Rumpfes und b.) ausserhalb irgendwelcher Prozeduren.
Im 1. Fall werden alle Doku-Abschnitte erkannt und der Procedure zugeordnet ausgegeben.
TODO:
Um grössere Dokumentationsblöcke nicht mitten im Quellcode platzieren zu müssen ist noch eine Art Doku-Verweis einzubauen. An
der Stelle, an der im HTML-Dokument ein Text erscheinen soll ist im
Quellcode nur noch ein "Link" auf einen am Modul-Ende stehenden Block
einzufügen. Das soll die Übersichtlichkeit im Source wahren.