26. März 2008

Dokumentation für "PL/SQL und Betriebssystemkommandos" verfügbar: Danke an "pldoc"

Documentation for file system interaction available: Thanks to pldoc!

Nun steht endlich auch eine Dokumentation für die PL/SQL Packages und Types zum Aufruf von Betriebssystem-Kommandos bereit. Ich hatte befürchtet, dass dies länger dauern wird, denn eine vernünftige, bedienbare Dokumentation für drei Packages und einen Objekttypen zu erstellem ist ja schon ein wenig Aufwans. Der Patrick Wolf hat mir aber in Bensheim den Tipp gegeben, mir pldoc, einen Open Source-Dokumentationsgenerator für PL/SQL anzusehen. pldoc funktioniert für PL/SQL wie javadoc für Java. Man kommentiert direkt im Code, verwendet spezielle Tags wie @param oder @return und der Parser erstellt dann automatisch eine HTML-Dokumentation, wie man sie von Java gewohnt ist.
Einziger Wermutstropfen: PL/DOC kann keine Objekttypen; und gerade die habe ich für den PL/SQL File Handle verwendet. Also habe ich für den pldoc Parser eine Package Spec geschrieben, welche dem Objekttypen entspricht ... nicht schön, aber machbar.
Schaut einfach mal rein - die neue Dokumentation befindet sich nur einen Link entfernt.
Nebenbei habe ich denn auch eine neue Version 0.5.1 eingestellt, denn die 0.5er hatte ein paar Fehler, so dass der Code auf einer 10er-Datenbank nicht kompilierte; das kommt davon, wenn man nicht richtig testet.
The documentation to my packages and types for operating and file system interaction is available. I was afraid that this would take a lot of time since creating a comprehensive and easy-to-use documentation for all the packages is some effort. But Patrick Wolf and I talked in Bensheim he pointed me to PLDOC, an open source documentation generator for PL/SQL. pldoc works for PL/SQL like javadoc for Java. It parses the comments, special tags like @param or @return as well as the PL/SQL code and generated a pretty HTML documentation.
There was just one point: pldoc cannot handle object types - and my implmentation for the file handle is an object type - so I created a package spec which describes the object type - not very nice but OK.
Just give it a try - the new API documentation is just a link away.
BTW: I added version 0.5.1 - the previous one had some bugs which prevented them from compiling in an Oracle10 database ... testing is everything I'm afraid ...

Keine Kommentare:

Beliebte Postings