Click here to monitor SSC
SQLServerCentral is supported by Red Gate Software Ltd.
 
Log in  ::  Register  ::  Not logged in
 
 
 
        
Home       Members    Calendar    Who's On


Add to briefcase

Creating Stored Procedure Documentation with XML, SQL-DMO and XSLT Expand / Collapse
Author
Message
Posted Sunday, May 5, 2002 12:00 AM
Forum Newbie

Forum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum Newbie

Group: General Forum Members
Last Login: Thursday, June 15, 2006 5:03 AM
Points: 2, Visits: 1
Comments posted to this topic are about the content posted at http://www.sqlservercentral.com/columnists/MWittrock/tsqldoc.asp


Post #4035
Posted Monday, May 6, 2002 6:47 AM
SSC Eights!

SSC Eights!SSC Eights!SSC Eights!SSC Eights!SSC Eights!SSC Eights!SSC Eights!SSC Eights!

Group: General Forum Members
Last Login: Tuesday, July 31, 2007 8:20 AM
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"
Post #33086
Posted Monday, May 6, 2002 12:53 PM
Forum Newbie

Forum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum Newbie

Group: General Forum Members
Last Login: Thursday, October 30, 2008 4:32 PM
Points: 9, Visits: 53
Great article - worked "right out of the box"!


Post #33087
Posted Wednesday, May 8, 2002 1:24 PM
SSCertifiable

SSCertifiableSSCertifiableSSCertifiableSSCertifiableSSCertifiableSSCertifiableSSCertifiableSSCertifiableSSCertifiable

Group: Moderators
Last Login: 2 days ago @ 6:56 AM
Points: 6,804, Visits: 1,934
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
Post #33088
Posted Thursday, May 9, 2002 2:41 PM
Forum Newbie

Forum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum Newbie

Group: General Forum Members
Last Login: Thursday, June 15, 2006 5:03 AM
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



Post #33089
Posted Sunday, March 9, 2003 9:55 AM
Mr or Mrs. 500

Mr or Mrs. 500Mr or Mrs. 500Mr or Mrs. 500Mr or Mrs. 500Mr or Mrs. 500Mr or Mrs. 500Mr or Mrs. 500Mr or Mrs. 500

Group: General Forum Members
Last Login: Wednesday, July 9, 2014 3:08 PM
Points: 570, Visits: 142
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.




Post #33090
Posted Tuesday, April 1, 2003 8:34 AM
Forum Newbie

Forum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum Newbie

Group: General Forum Members
Last Login: Thursday, September 15, 2005 3:56 PM
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
Post #33091
Posted Sunday, December 7, 2003 1:30 PM
Forum Newbie

Forum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum Newbie

Group: General Forum Members
Last Login: Monday, March 17, 2008 8:07 PM
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).)






Post #33092
Posted Tuesday, November 6, 2007 11:46 AM
Valued Member

Valued MemberValued MemberValued MemberValued MemberValued MemberValued MemberValued MemberValued Member

Group: General Forum Members
Last Login: Wednesday, February 26, 2014 9:18 PM
Points: 66, Visits: 532
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
Post #419225
Posted Thursday, January 13, 2011 2:19 AM
Forum Newbie

Forum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum Newbie

Group: General Forum Members
Last Login: Friday, February 11, 2011 2:25 AM
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 gentle:)
Post #1047074
« Prev Topic | Next Topic »

Add to briefcase

Permissions Expand / Collapse