Take the 2-minute tour ×
Database Administrators Stack Exchange is a question and answer site for database professionals who wish to improve their database skills and learn from others in the community. It's 100% free, no registration required.

Oracle SQL Developer (I'm using v3.2) has a feature called "DB Doc", which generates documentation for database objects. I mostly want to use it to generate documentation for my stored procedures, functions, packages and types. However, I can't find any documentation for it, describing what syntax I should use.

I have worked out that I should use a /* ... */ comment on the line(s) immediately above my procedure/whatever, and (by borrowing from JavaDoc) I have successfully used @param and @returns statements, but I'm not sure what else I can use. For example, are there fields for author, version, data modified, etc.?

I've done numerous searches of this site, Google, and Oracle's documentation, to no avail!

share|improve this question
2  
Hardly definitive, but this article says 'SQL Developer has extended pldoc into DB Doc', and the pldoc documentation seems to include the elements you've already found. Seems odd though that there doesn't seem to be any reference (or credit) to pldoc, so maybe it was just inspiration rather than included; and even odder than Oracle haven't documented the functionality at all. –  Alex Poole Oct 17 '12 at 9:10
    
Examples here –  thatjeffsmith Jan 14 at 18:11
    
Thanks @thatjeffsmith, but you're just reinforcing my point, that there isn't any formal documentation for this feature. In any case, I've since moved jobs and I no longer work with Oracle software, but thanks for taking the time to reply. –  Allan Lewis Jan 14 at 20:50
    
No, I agree. We need to extend the docs to clue people into that. Otherwise, it's Google to find that out, and we can do better. –  thatjeffsmith Jan 15 at 18:27

Your Answer

 
discard

By posting your answer, you agree to the privacy policy and terms of service.

Browse other questions tagged or ask your own question.