Bau eines Auto-PL/SQL-DOC-Generator

[JeanLucPicard]

Hallo PL/SQL-Fans!

In einem anderen Thread (der dadurch wiedermal OFFTopic wurde ) entstand das Thema, dass man einen DOC-Generator für PL/SQL-Code bauen könnte, ähnlich dem, der in JAVA für die JAVA-Docs benutzt wird.

Wir können uns ja hier über die Anforderungen eines solchen Tools unterhalten, in welcher Sprache man dieses Tool realisiert (z.B. könnte es auch wichtig sein, dass dieses dann mit der Datenbank auch kommuniziert. usw usw....

Ich werde nachher mal ein paar Gedanken dazu schreiben, aber derzeit habe ich noch ein wenig zu programmieren. Vielleicht steht aber bis dahin hier auch schon was

Gruss Helko!

[shad0w]

was verstehst du unter einem DOC generator?

[JeanLucPicard]

Du dokumentierst doch deinen Programm-Code.

Jede Funktion/Prozedur hat doch z.B. einen Kommentar-Kopf wo die Parameter, die Funktion an sich, der Rückgabewert usw usw beschrieben sind.

Aus den ganzen Informationen im Quelltext kann z.B. in eine HTML-Dokumentation automatisch erstellt werden.

Schau Dir mal die JAVA-DOCs an. Sowas bräuchte man fürs PL/SQL auch mal.

[shad0w]

hmm .. dokumentieren tu ich nicht sehr viel, da ich immer nur ein paar kleine funktionen und prozeduren schreibe ... da kommt als kommentar rein, was das ding macht und gut ist.

aber an sich ne recht geniale idee ... denk aber dass es extrem schwer umzusetzen ist.

[JeanLucPicard]

Von einem Python-Programmierer hier ganz in der Nähe meines Büros kam "das ist nicht so schwer" aber er hat keine Zeit

Drum wollte ich jetzt sowas mal bauen, wenn ich mal Zeit habe

Ich wollte hier jetzt aber gene mal diskutieren, was man alles beim Bau eines solchen Tools beachten sollte.

ps: in meinen Codes überwiegt der Kommentarteil übrigens meistens oder ist gleich auf mit der Größe des Codes