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 12»»

Documenting Stored Procedures Expand / Collapse
Author
Message
Posted Sunday, October 12, 2003 12:00 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, November 5, 2013 9:05 AM
Points: 976, Visits: 59
Comments posted to this topic are about the content posted at http://www.sqlservercentral.com/columnists/rmarda/documentingstoredprocedures.asp



Robert W. Marda
SQL Programmer
Ipreo
Post #17195
Posted Monday, October 20, 2003 8:40 AM


SSChasing Mays

SSChasing MaysSSChasing MaysSSChasing MaysSSChasing MaysSSChasing MaysSSChasing MaysSSChasing MaysSSChasing Mays

Group: General Forum Members
Last Login: Wednesday, April 30, 2014 9:23 AM
Points: 649, Visits: 206
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





Post #83023
Posted Monday, October 20, 2003 9:55 AM
Forum Newbie

Forum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum NewbieForum Newbie

Group: General Forum Members
Last Login: Wednesday, June 23, 2004 5:36 PM
Points: 7, Visits: 1
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




Post #83024
Posted Monday, October 20, 2003 10:44 AM


SSC-Dedicated

SSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-DedicatedSSC-Dedicated

Group: Administrators
Last Login: Yesterday @ 4:05 PM
Points: 33,165, Visits: 15,299
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/
www.dkranch.net







Follow me on Twitter: @way0utwest

Forum Etiquette: How to post data/code on a forum to get the best help
Post #83025
Posted Monday, October 20, 2003 10:55 AM
SSC Rookie

SSC RookieSSC RookieSSC RookieSSC RookieSSC RookieSSC RookieSSC RookieSSC Rookie

Group: General Forum Members
Last Login: Wednesday, January 16, 2013 9:49 AM
Points: 35, Visits: 13
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".







Post #83026
Posted Monday, October 20, 2003 11:27 AM
Hall of Fame

Hall of FameHall of FameHall of FameHall of FameHall of FameHall of FameHall of FameHall of FameHall of Fame

Group: General Forum Members
Last Login: Yesterday @ 3:31 PM
Points: 3,244, Visits: 534
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.




Post #83027
Posted Tuesday, October 21, 2003 7:37 AM
Right there with Babe

Right there with BabeRight there with BabeRight there with BabeRight there with BabeRight there with BabeRight there with BabeRight there with BabeRight there with Babe

Group: General Forum Members
Last Login: Tuesday, October 21, 2003 12:00 AM
Points: 728, Visits: 1
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.




Post #83028
Posted Tuesday, October 19, 2004 11:21 PM
Grasshopper

GrasshopperGrasshopperGrasshopperGrasshopperGrasshopperGrasshopperGrasshopperGrasshopper

Group: General Forum Members
Last Login: Monday, October 2, 2006 9:55 PM
Points: 12, Visits: 1

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.




Post #142500
Posted Wednesday, October 20, 2004 9:52 AM
SSCrazy

SSCrazySSCrazySSCrazySSCrazySSCrazySSCrazySSCrazySSCrazy

Group: General Forum Members
Last Login: Tuesday, June 19, 2012 10:11 AM
Points: 2,689, Visits: 36

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!!! 

 

Post #142587
Posted Wednesday, October 20, 2004 11:40 PM
SSC-Addicted

SSC-AddictedSSC-AddictedSSC-AddictedSSC-AddictedSSC-AddictedSSC-AddictedSSC-AddictedSSC-Addicted

Group: General Forum Members
Last Login: Tuesday, June 12, 2007 12:49 AM
Points: 419, Visits: 1

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
Post #142679
« Prev Topic | Next Topic »

Add to briefcase 12»»

Permissions Expand / Collapse