We help IT Professionals succeed at work.

Automatic generation of documentation for SQL and PL SQL. Tools? How to?

nba71 asked
Last Modified: 2013-12-19
Hello everybody,
having to face a legacy system (Oracle 9.2) we have to write a descriptive documentation about the logic inside PL SQL procedures and packages.
What we are thinking is to write comments in well defined tags inside procedures (during the analysis work) and then extract them with a parsing operation.
Do you know a tool able to do this work?
The aim is to generate a technical documentation repository based directly on the code.

Thx, Nicola.
Watch Question

David VanZandtSr Software Engineer

My problem with extracting text from PL/SQL is that it requires precise and consistent search criteria.  The moment a new teammate deviates from the convention, you're toast.  Secondly, in many production shops such code should be wrapped to obfuscate it.  And FWIW, COMMENT is great but only works upon tables, views, and such: http://download.oracle.com/docs/cd/B19306_01/server.102/b14200/statements_4009.htm#i2119719
I look forward to others' ideas, but I think you will end up with some variation of a word processor:  search for a text string, find its delimiter, and pretty up the result set.  AWK/SED in UNIX is another common approach.
You may find Oracle's vastly improved Software Configuration Manager (SCM) (at Metalink if you have a support contract) will vastly improve your ability to meet your last objective.  
Kind regards,
Database Developer & Administrator
Most Valuable Expert 2011
Top Expert 2012
This one is on us!
(Get your first solution completely free - no credit card required)


Thank you.
I agree with both your comments. Despite of opinions we'll face a contability system developed several years ago and not already documented. Every idea or tool can support!


Gain unlimited access to on-demand training courses with an Experts Exchange subscription.

Get Access
Why Experts Exchange?

Experts Exchange always has the answer, or at the least points me in the correct direction! It is like having another employee that is extremely experienced.

Jim Murphy
Programmer at Smart IT Solutions

When asked, what has been your best career decision?

Deciding to stick with EE.

Mohamed Asif
Technical Department Head

Being involved with EE helped me to grow personally and professionally.

Carl Webster
CTP, Sr Infrastructure Consultant
Empower Your Career
Did You Know?

We've partnered with two important charities to provide clean water and computer science education to those who need it most. READ MORE

Ask ANY Question

Connect with Certified Experts to gain insight and support on specific technology challenges including:

  • Troubleshooting
  • Research
  • Professional Opinions
Unlock the solution to this question.
Join our community and discover your potential

Experts Exchange is the only place where you can interact directly with leading experts in the technology field. Become a member today and access the collective knowledge of thousands of technology experts.

*This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.


Please enter a first name

Please enter a last name

8+ characters (letters, numbers, and a symbol)

By clicking, you agree to the Terms of Use and Privacy Policy.