Generate stored proc documentation

• lalit-450914

  SSC-Addicted

  Points: 462

  More actions

  December 19, 2007 at 12:52 am

  #177644

  Hi,

  My friend has lots of stored procedure and are marking comments on them. I wanted to know free tools that can be used to generate documentation out of those comments.

  Is there any particular format in which the comments have to be written

  We use Sql 2005

  thanks.

• StarNamer

  SSCrazy Eights

  Points: 8746

  More actions

  December 20, 2007 at 3:38 am

  #761691

  Depending on what you want to do, how about Perl? (Try http://www.activestate.com/Products/activeperl/

  You can either create your own format or use it's POD format.

  For example:

  create procedure userproc

  as

  /*

  =head1 xproc

  =head2 Parameters

  None

  =head2 Description

  This selects a list of all users

  =cut

  */

  begin

  select * from tbluser

  end

  Then run 'pod2text xproc.sql' produces

  xproc

  Parameters

  None

  Description

  This selects a list of all users

  There's also pod2html and maybe others.

  Derek