Home All Groups Group Topic Archive Search About

tool for creating documentation for stored procs

Author
17 Feb 2006 2:15 PM
Dirk Theune
Hi,

I am looking for a tool to automatically create documentation for stored
procedures.
I am thinking of something similar to ndoc in .NET, which creates doc from
the comments in the stored procedure. Does anybody know of such a tool?

Kind regards,
Dirk

Author
17 Feb 2006 3:19 PM
JT
For what it's worth, you can return a good deal of information about a
stored procedure using the following methods:

-- The following will return the creation date/time and input parameters for
a stored procedure:
sp_help 'usp_myproc'

-- The following (undocumented) procedure call will return all tables and
views referenced within a stored procedure:
sp_MSdependencies 'usp_myproc'

-- The following will return comment lines from a stored procedure; at least
those commented using the -- prefix. For comments delimited by /*   */, you
will need to expand on this.
create table #spcomments
(
comment varchar(8000)
);
insert into #spcomments exec sp_helptext 'usp_myproc';
select comment from #spcomments where left(comment,2) in ('--');
drop table #spcomments;



Show quote
"Dirk Theune" <DirkThe***@discussions.microsoft.com> wrote in message
news:91E897A3-CDDB-43E8-8E57-5A0B00B8D204@microsoft.com...
> Hi,
>
> I am looking for a tool to automatically create documentation for stored
> procedures.
> I am thinking of something similar to ndoc in .NET, which creates doc from
> the comments in the stored procedure. Does anybody know of such a tool?
>
> Kind regards,
> Dirk

AddThis Social Bookmark Button