Click here to monitor SSC
SQLServerCentral is supported by Redgate
 
Log in  ::  Register  ::  Not logged in
 
 
 


Creating Stored Procedure Documentation with XML, SQL-DMO and XSLT


Creating Stored Procedure Documentation with XML, SQL-DMO and XSLT

Author
Message
mwittrock
mwittrock
Forum Newbie
Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)

Group: General Forum Members
Points: 2 Visits: 1
Comments posted to this topic are about the content posted at http://www.sqlservercentral.com/columnists/MWittrock/tsqldoc.asp



ckempste
ckempste
SSC Eights!
SSC Eights! (885 reputation)SSC Eights! (885 reputation)SSC Eights! (885 reputation)SSC Eights! (885 reputation)SSC Eights! (885 reputation)SSC Eights! (885 reputation)SSC Eights! (885 reputation)SSC Eights! (885 reputation)

Group: General Forum Members
Points: 885 Visits: 1
Great article and very imformative.

Cheers

Chris


Chris Kempster
www.chriskempster.com
Author of "SQL Server Backup, Recovery & Troubleshooting"
Author of "SQL Server 2k for the Oracle DBA"
beadlesm
beadlesm
Forum Newbie
Forum Newbie (9 reputation)Forum Newbie (9 reputation)Forum Newbie (9 reputation)Forum Newbie (9 reputation)Forum Newbie (9 reputation)Forum Newbie (9 reputation)Forum Newbie (9 reputation)Forum Newbie (9 reputation)

Group: General Forum Members
Points: 9 Visits: 53
Great article - worked "right out of the box"!



Andy Warren
Andy Warren
SSCertifiable
SSCertifiable (7.2K reputation)SSCertifiable (7.2K reputation)SSCertifiable (7.2K reputation)SSCertifiable (7.2K reputation)SSCertifiable (7.2K reputation)SSCertifiable (7.2K reputation)SSCertifiable (7.2K reputation)SSCertifiable (7.2K reputation)

Group: Moderators
Points: 7227 Visits: 2679
Pretty nice. Great job on linking to other resources. Did you consider using the built in support for extended object properties?


Andy

Andy
SQLAndy - My Blog!
Connect with me on LinkedIn
Follow me on Twitter
mwittrock
mwittrock
Forum Newbie
Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)Forum Newbie (2 reputation)

Group: General Forum Members
Points: 2 Visits: 1
Hello all, and thanks for your kind words. Andy, I'm considering expanding the script to include documentation for other database objects, and for that, extended properties would definitely be the way to go. For stored procedures, specifically, I prefer embedding the documentation directly in the code, so that it can be added when the code is written.

Cheers,

Morten



Edited by - mwittrock on 05/09/2002 2:42:09 PM



ewelker
ewelker
Mr or Mrs. 500
Mr or Mrs. 500 (570 reputation)Mr or Mrs. 500 (570 reputation)Mr or Mrs. 500 (570 reputation)Mr or Mrs. 500 (570 reputation)Mr or Mrs. 500 (570 reputation)Mr or Mrs. 500 (570 reputation)Mr or Mrs. 500 (570 reputation)Mr or Mrs. 500 (570 reputation)

Group: General Forum Members
Points: 570 Visits: 176
Great article! I'd done something similar for table documentation. I was able to make just a few tweaks to extract the description based on our standard stored procedure documentation block. Was also able to easily change the XSL to report it in the format I've been using. This speaks well of the design, readability and documentation of your code.



davidfb
davidfb
Forum Newbie
Forum Newbie (5 reputation)Forum Newbie (5 reputation)Forum Newbie (5 reputation)Forum Newbie (5 reputation)Forum Newbie (5 reputation)Forum Newbie (5 reputation)Forum Newbie (5 reputation)Forum Newbie (5 reputation)

Group: General Forum Members
Points: 5 Visits: 1
Excellent topic..

But i´m having a problem when i try to use the transform.xslt:

msxml4.dll: The stylesheet does not contain a document element. The stylesheet may be empty, or it may not be a well-formed XML document.

what´s happening? The XML that was generated seems to be normal to me..

David Falcão
www.darte.com.br


David Falcão
www.darte.com.br
MikeGale
MikeGale
Forum Newbie
Forum Newbie (6 reputation)Forum Newbie (6 reputation)Forum Newbie (6 reputation)Forum Newbie (6 reputation)Forum Newbie (6 reputation)Forum Newbie (6 reputation)Forum Newbie (6 reputation)Forum Newbie (6 reputation)

Group: General Forum Members
Points: 6 Visits: 4
Great to see this approach.

I'm looking for a way to integrate documentation of SQL Server sprocs into documentation of .NET assemblies. (The assemblies are documented using NDoc so they look like the MS .NET documentation.)

The sprocs already contain documentation.

Has anyone done this already? (The approach probably involves producing XML files in the .NET / C# / NDoc format (easy) and modifications to NDoc to handle sprocs (unknown).)



StillaLearner
StillaLearner
Valued Member
Valued Member (68 reputation)Valued Member (68 reputation)Valued Member (68 reputation)Valued Member (68 reputation)Valued Member (68 reputation)Valued Member (68 reputation)Valued Member (68 reputation)Valued Member (68 reputation)

Group: General Forum Members
Points: 68 Visits: 550
Hi - I have tried to access the code for this utility but the site doesn't find it - has this been pulled?

If so can anyone suggest where I can find a piece of software that will document the comment test in stored procedures, functions.

If the source has moved can someone please re-direct me

thanks
khanrashed110
khanrashed110
Forum Newbie
Forum Newbie (1 reputation)Forum Newbie (1 reputation)Forum Newbie (1 reputation)Forum Newbie (1 reputation)Forum Newbie (1 reputation)Forum Newbie (1 reputation)Forum Newbie (1 reputation)Forum Newbie (1 reputation)

Group: General Forum Members
Points: 1 Visits: 10
Hi
I'm no expert on this but are there not a number of programs that can make XML documentation for you. To give you an example I just did a quick google search and found this one:
http://www.liquid-technologies.com/xsd-to-html.aspx

It can make the documentation for you as long as you have the schemas and I have found a few other ones as well.

This is my first post from a newbie XML enthusiast so if I am wrong please be gentleSmile
Go


Permissions

You can't post new topics.
You can't post topic replies.
You can't post new polls.
You can't post replies to polls.
You can't edit your own topics.
You can't delete your own topics.
You can't edit other topics.
You can't delete other topics.
You can't edit your own posts.
You can't edit other posts.
You can't delete your own posts.
You can't delete other posts.
You can't post events.
You can't edit your own events.
You can't edit other events.
You can't delete your own events.
You can't delete other events.
You can't send private messages.
You can't send emails.
You can read topics.
You can't vote in polls.
You can't upload attachments.
You can download attachments.
You can't post HTML code.
You can't edit HTML code.
You can't post IFCode.
You can't post JavaScript.
You can post emoticons.
You can't post or upload images.

Select a forum

































































































































































SQLServerCentral


Search