6.7 Dokumentation

Previous PageTable Of ContentsNext Page

Für die Dokumentation der GEA Toolbox mußte eine Variante gefunden werden, die dieselbe leichte und problemlose Portierbarkeit ermöglicht, wie dies für den Quelltext der GEA Toolbox der Fall ist. Deshalb wurde die gesamte Dokumentation in HTML geschrieben. Für alle Rechnerplattformen, auf denen Matlab verfügbar ist, gibt es auch einen HTML-Browser zum Ansehen der Dokumentation.

Die Dokumentation der GEA Toolbox [Poh96] ist in drei Teile gegliedert. Im ersten Teil, dem Tutorial, wird eine Einführung in die Arbeit und die Anwendung der Toolbox gegeben. Den zweiten Teil bildet eine ausführliche Erläuterung der implementierten Algorithmen sowie einiger theoretischer Erkenntnisse. Im dritten Teil werden alle Teile der Toolbox ausführlich dokumentiert. Dies beinhaltet die Dokumentation des Quelltextes aller Funktionen und Routinen, die Bedeutung und möglichen Belegungen der Parameter sowie eine ausführliche Erläuterung aller Beispielfunktionen. Alle Teile der Dokumentation der GEA Toolbox sind durch Querverweise miteinander verbunden, wodurch eine einfache Navigation zwischen den Teilen und zu verwandten Themen gewährleistet ist.

Die Dokumentation des Quelltextes der Toolbox wird durch ein speziell entwickeltes Perlskript generiert. Dieses Skript erstellt alle notwendigen Verzeichnisse, extrahiert Informationen, faßt Angaben zusammen und führt eine Aufsplittung des Quelltextes jeder Funktion in die einzelnen Bereiche (Funktionskopf, Hilfstext, Quelltext) durch. Außerdem werden alle Abhängigkeiten zwischen den Funktionen erkannt und für jede Funktion die aufrufenden und aufgerufenen Funktionen zusammengestellt. Das Perlskript arbeitet über einen Verzeichnisbaum. Damit kann eine Vorstrukturierung der Funktionen in Gruppen vorgenommen werden, die sich dann in der Dokumentation widerspiegelt.

Durch die automatisierte Erstellung der Dokumentation des Quelltextes ist gewährleistet, daß die Dokumentation per Tastendruck auf dem neuesten Stand ist und selbst letzte Änderungen sofort berücksichtigt werden. Weiterhin wird durch die Hypertextverbindungen zwischen den Funktionen ein schnelles Kennenlernen der GEA Toolbox auf der Ebene des Quelltextes ermöglicht. Schließlich wird die Aufgabe zur Kommentierung der Implementierung von Algorithmen direkt in den Quelltext verlagert und muß dadurch nur an einer Stelle vorgenommen werden.


Previous PageTable Of ContentsList Of FiguresList Of TablesNext Page

Diese Dokument ist Teil der Dissertation von Hartmut Pohlheim "Entwicklung und systemtechnische Anwendung Evolutionärer Algorithmen". This document is part of the .
The is not free.
© Hartmut Pohlheim, All Rights Reserved, (hartmut@pohlheim.com).