SQL best practice : comment your objects?

Posted November 15th, 2006 by JB

I was wondering what each of your Business Practice is of creating header comment for each of your SQL objects (views,functions,triggers)...I know I have a really bad habit of not always doing it with everything I create and or leaving parts out.. I want to start documenting these things for my company..

Do you all give examples, define the Pre and Post conditions? etc....

Do you have a different format for each type of language.. your VB,ActiveX,Coldfusion,Javascript,CSS... all have the same format?

Here is my typical header comment

/*
Object: lca_sp_TrackErrors
Author: JB
Date: 3/8/2005
Purpose: Track User Data-Entry Errors. When a LCA Businerss Process has been broken
Note: [notes about the object that a user will need to know]

Updates:
[date] [author]
* [note about update]
*/

JB's blog | login or register to post comments | printer friendly version

We use our Source Control for SQL procs

On May 14th, 2007 chris_castle says:

It gives you the date for each edit and the person who edited it. It also gives you a place to comment on your changes. You lose the benefit of editing the procedure right in SQL Management Studio, but that is now part of SQL 2005.

What Source Control software

On May 16th, 2007 JB says:

What Source Control software do you use?

we just bought VS 2005 and wondering if Visual SourceSafe is any good

I used Visual Studio for 9 years.

On May 16th, 2007 chris_castle says:

I really liked it as a product. Three years ago, our church opted to use A product by SourceGear called Vault. I like the integration it has with their issue tracking system called Dragnet. I really like both of these products. SourceGear has been very great to work with the whole time we have been on it.

Regardless of the source control system you use, you will love having one. I can't tell you how many time I use the diff to see the differences in two version of a procedure.

Chris

So Visual SourceSafe is.....safe?

On May 16th, 2007 JB says:

I have been reading some reviews regarding SourceSafe about how sometimes corrupts the files

It is safe

On May 16th, 2007 chris_castle says:

I used it for years.

VSS is not entirely safe

On August 24th, 2007 Bruce Wilson says:

I've also used it for years, and had corruptions that locked me out of the repository several times. Some data loss each time. I've been using Subversion with great results for about a year now, and I'm just about to migrate my VSS repository (what I can) over to SVN. There's even an excellent VSS2SVN project on SourceForge.

There's an add-on for Subversion called TortoiseSVN which adds SVN integration directly into Windows Explorer. See the status of any file, check in, check out, get latest, right from a right-click menu.

Oh, and Subversion allows you to do many operations offline, and those that require online access are much faster than VSS.

I can't say enough good things about SVN.

-- Bruce

iMIS Community