Documenting Stored Procedures

  • Robert W Marda

    SSChampion

    Points: 13413

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

    Robert W. Marda
    Billing and OSS Specialist - SQL Programmer
    MCL Systems

  • Philip Kelley

    SSCertifiable

    Points: 6351

    One thing I always try to do is add a comment at the start of a "programming block" -- BEGIN, IF, ELSE, WHILE. It really helps when reviewing code to have a quick comment on what's going on in this IF block, or what occurs in each iteration of the WHILE loop.

    Here's an outline. (Please note that I do indent my code; I've yet to figure out how to get this forum to accept leading spaces on new paragraphs.)

    IF <someCondition>

    BEGIN

    -- Description of conditions causing this IF code to run

    END

    ELSE

    BEGIN

    -- Description of conditions causing this ELSE code to run (very useful if the IF clause is fifty lines back)

    END

    ENDIF

  • ensslen

    SSC Veteran

    Points: 211

    If you're going to be generating external documentation (which some internal/external clients like) then the data dictionary can be used to great effect to streamline your process.

    Even a relatively simple SELECT statement against SYSCOMMENTS can extract the "Basic Comment" at the begining of every procedure. You could then XML->XSL that output to word as HTML or use PRINT statements to output it to word as cut and paste.

    Generally though, I feel that such documentation is not worth any effort, even as rapid a process as this one.

    Steven

  • Steve Jones - SSC Editor

    SSC Guru

    Points: 720887

    Nice summary of items. Personally I usually set parameters to NULL and then check for NULL to display the "you need parameter x" included" message.

    I'm wary of external documentation. People get too busy and this is difficult to keep up with, so I don't recommend it. Instead, I prefer to keep any notes, docs, etc. in the proc. Still searching for a good way to provide this to new people, but I think it needs to be kept with the code.

    Steve Jones

    sjones@sqlservercentral.com

    http://www.sqlservercentral.com/columnists/sjones

    The Best of SQL Server Central.com 2002 - http://www.sqlservercentral.com/bestof/

    http://www.dkranch.net

  • rawheiser

    Old Hand

    Points: 341

    Its not exactly 'documentation' but ...

    Don't forget the ability of VSS or your source control system to use keywords to keep the basic date/time last changed info up to date.

    As someone who moves procs around, having this header helps me quickly see what is in production and in test (see below for my basic header).

    /*

    ---------------------------------------------

    $Logfile: $

    $Revision: $

    $Date: $

    ---------------------------------------------

    */

    As far as internal/external documentation ... the internal stuff helps you understand the actual functioning of the object, but good external documentation helps you understand the overall system.

    And don't forget consistant standards in naming objects and variables. That assists better than volumes of text in "getting it".

  • SQLBill

    SSC Guru

    Points: 51440

    I liked the article, especially the description of how to put in the informative directions using the PRINT command. I'm going to go through my sp's and see where I can use that.

    -SQLBill

    *If you're not learning something every day - you are asleep or just dead.

  • jpipes

    SSChampion

    Points: 12230

    Good article, but I have only one disagreement. Instead of PRINT statements, I prefer to use RAISERROR. With RAISERROR, you can pass in variables to make the error message descriptive, plus it actually produces an error, which can be caught and rethrown by the calling procedure if necessary. Example:

    
    
    CREATE PROC MyProc1
    @LastName VARCHAR(30) = ''
    , @FirstName VARCHAR(30) = ''
    AS
    IF @LastName = '' OR @FirstName = '' BEGIN
    RAISERROR('MyProc1 expects both parameters @FirstName and @LastName. Both are VARCHAR(30). Values supplied were @LastName: %s and @FirstName: %s', 16, 1, @LastName, @FirstName)
    END
    ...

    Just my 2 cents.

  • merceroz

    SSC Enthusiast

    Points: 132

    I prefer to add my comments after the create procedure, eg

    create proc rpcNameOfProc

       @AcctMonthEndDate datetime

    as

    --Custom script created for Client

    --This script should be reinstalled and tested at time of an upgrade.

    --Name - rpcNameOfProc

    --Version - 4

    --Author - Gareth Mercer

    --Create Date - 20 October 2004

    --Description - Used for the report Report.rpt

    That way when you're at a client's and you want to know what version they have, you can do an

    sp_helptext, rather than rely on the client to have a record.

  • leslaw

    SSCrazy

    Points: 2875

    Your's example code:

    It's better to use statements like :

      if @parameter is null ....

     

    SP parameters can be obtained from metadirectory

     

    Uneeded and espesially not current comments are wost then none!!! 

     

  • Julian Kuiters

    SSCertifiable

    Points: 6585

    RAISERROR is the way to go if you are going to throw an error up the chain.

    At the very least if you are using RETURN you should be giving RETURN a value so that your calling EXEC knows there was a failure.

    CREATE PROC dbo.myBad
       @myInt    int    = 0
    AS
       IF @myInt = 0
           RETURN 1    --- @myInt can't be 0
    GO
    DECLARE @myResult int
    EXEC @myResult = dbo.myBad
    IF @myResult <> 0
    BEGIN -- Error handling routine
        PRINT 'There was an error'
        .....
    END

     


    Julian Kuiters
    juliankuiters.id.au

  • karchem

    SSC Rookie

    Points: 33

    These are great ideas when creating/update SPs.

    How about the problem of existing SPs - getting a list of parms, keys, etc. that already exist but are undocumented as noted in the article? Are there any tools or tricks to getting this information w/o touching every SP manually?

  • jumpin

    SSC-Addicted

    Points: 422

    Good question. I'd also like to know that...

  • SSIS Guy

    SSCommitted

    Points: 1667

    Here is one more Free Tool to document Sql Server Database

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

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