DB Dokumentation mit ORACLE SQL Developer 3.1 erstellen

Wer sich sinnvoller Weise die Mühe macht und seinen PL/SQL Code mit PLDOC-Notation dokumentiert, hat bei der automatischen Generierung der HTML-Dokumentation leichtes Spiel. Der ORACLE SQL Developer 3.1 kann mit nur wenigen Mausklicks eine solche erstellen.

1. gewünschte Datenbankconnection auswählen
2. rechte Maustaste –> Generate DB Doc…
3. nun nur noch das gewünschte Output-Verzeichnis angeben und die Datenbankobjekte (z.B. Tabelle, Views usw.) auswählen, für die eine HTML-Dokumentation erstellt werden soll.

Um das Ergebnis der Generierung zu betrachten, in das angegebene Output-Verzeichnis zu wechseln und die Datei index.html öffnen.

Wer die Notation von PLDOC nicht kennt, kann unter http://pldoc.sourceforge.net/ alle notwendigen Informationen des Open Source Projektes finden.

In einigen Projekten habe ich erlebt, dass fehleranfällige, selbstenwickelte Parser geschrieben wurden, um eine Systemdokumentation zu erstellen. Ich empfehle jedoch stark den Einsatz von PLDOC, da sich diese Notation m.E. als Standard in der Dokumentation von PL/SQL Quellcode etabliert hat.