~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	AT Docunator

  Quellcode-Dokumentations-System
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Einleitung
-----------
Ausgehend vom Umgang mit Dokumentationssystemen wie JavaDoc, PHPDoc, PHPDocumentor etc. war mir das alles
irgendwie zu zeitraubend, zu komplex. Sich mit den einzelnen Doctags im Quellcode herumzuschlagen find ich
nervig. Nun mag jeder anderer Meinung sein; für mich sind diese ganzen mittlerweile doch recht komplexen
Dokumentationssysteme zu aufreibend. Auch haben mich immer die festgeschriebenen DocTags genervt. Und da
ich mich schon seit Jahren mit diversen Facetten des Themas Dokumentation beschäftige, habe ich mir
kurzerhand einen eigenen Dokumentations-Generator für Quelltexte gebaut - den AT Docunator.

Architektur/Installation
------------------------
AT Docunator basiert auf dem AT Contenator, einem PHP-Framework, und ist als Ordner-Plugin ausgeführt.
Das heißt, daß der Docunator Ordner in jedes beliebige Contenator-System in den Root oder einem
Unterordner kopiert (installiert) werden kann und sofort zur Verfügung steht. Ebenso kann er auch
einfach wieder durch löschen des Ordner deinstalliert werden.

Was er kann
-----------
Er generiert anhand von festgelegten Grabzeichen (von grabben, greifen), die einem Kommentar vorangestellt werden,
eine fertige HTML-Dokumentation des Quelltextes. Dabei berücksichtigt er selbstdefinierte DocTags und zeichnet sie
in fetter Schrift aus. Jeder dokumentierbare Bereich wird in einen eigenen Rahmen gesetzt. Alle dokumentierten
Dateien stellt er links in einem Menü dar. Bilder und Grafiken werden in den Zielordner kopiert und
können ebenfalls aufgerufen/angezeigt werden. Dabei ist es unerheblich, in welchem Unterverzeichnis die
Dateien liegen. Zudem werden alle Dateien im Menü aufsteigend sortiert. Welche Dateiarten als Dokumentation
generiert werden sollen, kann in der docunator.config.dat eingestellt werden. Der ebenfalls in dieser
Datei eingestellte Style wird in die Dokumentation kopiert und ihr zugeordnet.
Vorhandene Quellcode-Dateien, die mit den üblichen DocTags für PHPDoc daherkommen, können ebenso als
Dokumentation generiert werden. Dazu müssen diese Doctags in der docunator.doctag.dat eingetragen werden.


Wie es funktioniert
-------------------
- in der docunator.config.dat Quell- und Zielpfad einstellen - relative Pfadangaben -> Standardeinstellung vorhanden
- ebenso Grabzeichen, Titel, Deckblatt und die zu generierenden Dateiarten -> Standardeinstellung vorhanden
- in der docunator.doctag.dat die gewünschten DocTags eintragen -> Standardeinstellung vorhanden
- zu dokumentierenden Quellcode in den Quellordner kopieren (einfach z.B. ein PHP-Projekt samt Unterordner reinkopieren)
- im Menü Docunator auf den Button Dokumentation generieren klicken -> die Dokumentation wird generiert
- abschließend auf den Link Generierte Dokumentation anzeigen klicken -> Dokumentation wird angezeigt


Haftungsausschluß
-----------------
Der Einsatz von AT Docunator ist auf eigene Gefahr. In keinster Weise kann eine Haftung in irgendeiner Weise
durch die Benutzung des Docunators bei Ausfall oder anderweitigen Schäden an Systemen oder Peripherie durch dessen
Einsatz hergeleitet werden. Alle erwähnten Markennamen/Markenzeichen gehören den jeweiligen Firmen/Personen.


Abschließende Bemerkungen
-------------------------
Die Generierung von Quellcode-Dokumentationen ist mit dem Docunator ganz einfach und völlig unkompliziert. Es wird
jede Art von Quellcode verschiedenster Programmiersysteme akzeptiert. Vorraussetzung ist natürlich, daß sich dessen
Programmierer an festgelegte und einfache Regeln halten. Das sollte jedoch nicht schwer sein, da das Konzept von
AT Docunator auf Einfachheit ausgelegt ist.

In diesem Sinne wünsche ich viel Spaß damit. Wenn Fragen sind und/oder Verbesserungs-/Änderungswünsche bestehen,
kann man mich jederzeit kontakten.


Powered by AT Contenator

© ansatheus 2003 - 2014 - ansatheus@gmx.net