Red Gate forums :: View topic - Embedded comments, etc within SQL SPs
Return to www.red-gate.com RSS Feed Available

Search  | Usergroups |  Profile |  Messages |  Log in  Register 
Go to product documentation
SQL Doc 1
SQL Doc 1 forum

Embedded comments, etc within SQL SPs

Search in SQL Doc 1 forum
Post new topic   Reply to topic
Jump to:  
Author Message
DavidAtABC



Joined: 22 Aug 2006
Posts: 10

PostPosted: Tue Nov 28, 2006 9:58 pm    Post subject: Embedded comments, etc within SQL SPs Reply with quote

Hi,

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
and
--##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.
Back to top
View user's profile Send private message
david connell



Joined: 21 Nov 2005
Posts: 207

PostPosted: Wed Nov 29, 2006 10:32 am    Post subject: Reply with quote

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?

Regards
David
Back to top
View user's profile Send private message
DavidAtABC



Joined: 22 Aug 2006
Posts: 10

PostPosted: Wed Nov 29, 2006 11:39 am    Post subject: Reply with quote

Hi,

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,

David.
Back to top
View user's profile Send private message
Display posts from previous:   
Reply to topic All times are GMT + 1 Hour
Page 1 of 1

 
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group