Paul Rohorzka hält beim 29. Wiener Access-Stammtisch einen Vortrag (TreeView) - Interessierte sind herzlich eingeladen. [mehr...]
Paul Rohorzka wurde heuer wieder als Referent zur Access Entwickler-Konferenz nach Nürnberg eingeladen. [mehr...]

Vorab-Information!

sCodeDocu

Mit softconcept sCodeDocu können direkt aus VB(A)-Code Dokumentationen generiert werden. Durch ein konfigurierbares System von Schlüsselwörtern kann zu Modulen, Prozeduren, etc. beschreibender Text definiert werden, der in die Dokumentation einfließt. Der Export ist nach XML oder fertig formatiert nach HTML möglich.

Es können Dokumentationen für unterschiedliche Adressaten generiert werden:

Im Startformular von softconcept sCodeDocu können diese drei Dokumentations-Arten erzeugt werden:

Das vorläufige Hauptformular von sCodeDocu

Analyse der Code-Struktur

softconcept sCodeDocu analysiert den Quellcode eines Projekts und baut daraus eine interne Datenstruktur mit den für eine Dokumentation relevanten Daten auf. Auf dieser Basis bauen alle weiteren Schritte auf.

Der folgende Screenshot zeigt beispielsweise einen Ausschnitt der Übersichtsseite, die automatisch generiert wurde. Die Klartext-Beschreibungen werden direkt dem Quelltext entnommen. Statistische Informationen werden ermittelt.

Überblick über die Module eines Projekts

Aufnahme von Code-Kommentaren in die fertig Dokumentation

Kommentare, die im Code zu bestimmten Elementen (Modulen, Prozeduren, Konstanten, Typen, Parametern, etc...) geschrieben sind, können nun auch unmittelbar in eine übersichtliche Dokumentation einfließen.

Hier sehen Sie einen kleinen Code-Ausschnitt mit kurzen Beschreibungen zur Funktionsweise der Prozedur und Beschreibungen für die Parameter:

Kommentierter Code

Diese Kommentare werden nun direkt in die fertige Dokumentation übernommen:

Die Kommentare in der fertigen Dokumentation

 

softconcept sCodeDocu wird auch als Entwickler-DLL erhältlich sein, sodass Sie selbst die Dokumentation nach Ihren Vorgaben und Wünschen gestalten können.