2009-08-26 5 views
7

Sto tentando di documentare in modo più completo i nostri pacchetti di database come API. Quello che vorremmo è qualcosa come JavaDocs per PL/SQL. Ho visto un paio di strumenti là fuori (pldoc, plsqldoc) ma vorrei sapere da persone che li usano come si confrontano.Documentazione Inline pacchetto Pl/SQL

risposta

6

Ho usato PlDoc e lo trovo veramente buono. Non ho usato altri strumenti quindi non posso confrontare. Ho trovato che PlDoc ha fatto bene le basi. Volevo alcune funzionalità più avanzate, quindi ho creato il nostro strumento che ha aggiunto estensioni a PlDoc per più tag. Inoltre, non faccio solo documentazione con esso. Genero anche le intestazioni dei pacchetti usando alcuni tag PlDoc (ad esempio @private).

Vi consiglio di provare PlDoc e quindi di ottimizzare ciò che non soddisfa le vostre esigenze. Non ci vuole molto tempo per impostare quindi non è un enorme investimento di tempo per provarlo.

2

Ho utilizzato NaturalDocs per alcuni anni e ho trovato facile da installare e utilizzare. È simile a JavaDocs e supporta più lingue, anche se l'ho usato solo con PL/SQL. Molto configurabile anche se non ho trovato necessario giocherellare con quello.

+0

Probabilmente non avrei trovato questo particolare strumento senza la tua risposta. Sebbene sia abbastanza accessibile, penso che una soluzione più rigidamente strutturata sia ciò di cui il nostro team ha bisogno. Grazie! –