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

  • mwittrock

    SSC Rookie

    Points: 40

    Comments posted to this topic are about the content posted at http://www.sqlservercentral.com/columnists/MWittrock/tsqldoc.asp

  • ckempste

    SSCoach

    Points: 17983

    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

    SSC Enthusiast

    Points: 159

    Great article - worked "right out of the box"!

  • Andy Warren

    SSC Guru

    Points: 119676

    Pretty nice. Great job on linking to other resources. Did you consider using the built in support for extended object properties?

    Andy

  • mwittrock

    SSC Rookie

    Points: 40

    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

    Mr or Mrs. 500

    Points: 578

    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

    Grasshopper

    Points: 19

    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

    http://www.darte.com.br


    David Falcão
    www.darte.com.br

  • MikeGale

    SSC Veteran

    Points: 222

    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

    SSCrazy

    Points: 2479

    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

    SSC Rookie

    Points: 29

    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:)

  • vinodajacob

    SSC Journeyman

    Points: 98

    Is there an  updated location for this script as the current location that is linked is no longer found

    Is this hosted somewhere else or does someone have another copy to update this document?

     

    Thanks,

    Vinod

Viewing 11 posts - 1 through 11 (of 11 total)

You must be logged in to reply to this topic. Login to reply