Embedded comments, etc within SQL SPs

Documents SQL Server 2000, 2005 and 2008 databases.

Embedded comments, etc within SQL SPs

Postby DavidAtABC » Tue Nov 28, 2006 8:58 pm


I like the tool - I've been waiting a long time for Red-Gate to do this tool and all of a sudden it appeared - thanks guys.

I evaluated a competitors tool some time back and haven't bought it yet, because I prefer your tools and wanted to give you a chance to produce it - glad I waited!

I'd like to propose a couple of extra features:

Ability for SQL Doc to parse and use embedded comments, eg:

--##SUMMARY - gives a summary of the SP's function
--##REMARKS - any remarks
--##SEEALSO - links to related SPs
--##PARAM - details about a parameter

These are then used to further detail the information produced by SQL Doc, making the documentation even more useful.

Thanks Guys.
Posts: 10
Joined: Tue Aug 22, 2006 4:34 pm

Postby david connell » Wed Nov 29, 2006 9:32 am

Hi David
Thanks for your comments.

I have some questions for you.
Do you use a standard too to generate these embedded comments? If not why do you use ##SUMMARY etc?
Which version of SQL Server are you using?
Does anyone else (ie other companies) do similar things and if so do you know what?

david connell
Posts: 168
Joined: Mon Nov 21, 2005 9:12 am

Postby DavidAtABC » Wed Nov 29, 2006 10:39 am


Sorry, I was not wanting mention a competitor in a public forum, however, these comments are used with ApexSQL Doc and provide quite a powerful means of adding useful comments which appear in seperate sections of the output documentation for each SP.

The comments are manually inserted.

I use both MS SQL Server 2000 and 2005.

Hope that helps,

Posts: 10
Joined: Tue Aug 22, 2006 4:34 pm

Return to SQL Doc Previous Versions

Who is online

Users browsing this forum: No registered users and 0 guests