The best SQL Stored Procedure Header EVAR

/******************************************************************************
** File:		my_stored_procedure
** Author: 		John Doe Programmer
** Copyright:		ABC Corp 2009
** Creation Date:	1/1/2009
** Description: 	Return data
** Version:		2.9
** Build:		291
** Number of bugs:	13
** Specification #:	13.123.123.12.312.3.123.234.34.5.2345.324.5.345.23.45.2345.23.45.3.45.3245.345.3.45.2345.3245.34.5.3245.2345
** 	Please refer to the requirements tracibility matrix to see how this beautifully links to the following requirements:
**      13.123.123.12.312.3.123.234.34.5.2345.324.5.345.23.45.2345.23.45.3.45.3245.344
**      13.123.123.12.312.3.123.234.34.5.2345.324.5
**      13.123.123.12.312.3.123.234.34.5.2345.324.5.345.23.45.2345.23.45.3.45.3245.342
**      13.123.123.12.312.3.128.234.34.5.2345.324.5.345.23.45.2345.23.45.3.45.3245.342
** Bug tracker ref:	Http://bugzilla/proc=12
** Temperature:		70
** Cubicle Size:		12x8
** Number of characters of text:
** Percent ratio of whitespace to letters 'e':
** List of people who think this is buggy:
** My favorite colors:
** My favorite pony:
** My boss's name:
** My boss's wife's name:
** Birthday of Dr. Codd:
** Description of what we think Dr. Codd would have to say about this stored procedure:
** Lawyers to call if you need to ask questions about the copyright notice:
** Number of colums referenced:
** Acronym list: WTF, STFU, TANSTAFL
** Abreviation list:  
** Misspellings we can't fix because there are too many dependencies on them:
** 10 ways to improve your code through comment headers:
** Phone number to call in case of emergency:
** Phone number of 911 service:
** Numer of time executed:
** Comment template:
**
** /***********
** ** File:		my_stored_procedure
** ** Author: 		John Doe Programmer
** ** Copyright:		ABC Corp 2009
** ** Creation Date:	1/1/2009
** ** Description: 	Return data
** ** --TODO: Finish copying template into all headers
**
**
** Db Objects affected list:  (this will be out of date on first edit)
** Called by: (This will be out of date, um tomorrow)             
** Return values: (This will be out of date, um today)
** Parameters: (because we should repeat source code in comments, its's good for you)
** Input					
** ----------					
** @ID  This is the ID. ID is short for identifier. Can you say 'aye dee'? I knew you could.
** @NEW_ID  This is the NEW_ID. This means "New Id".  Don't be confused by the underscores!
** Output
** -----------
** 0 or 1 or both.
** TODO: (INSERT ASCII ART HERE TO SUPPLEMENT BEAUTIFUL BOXES)
*******************************************************************************
** Change History
*******************************************************************************
** Date:		Author:				Description:
** --------		--------			-------------------------------------------
** 1-1-2009		Larry Smoe			Added header
** 1-2-2009		John Doe			Removed header
** 1-3-2009		Larry Smoe			Restored header
** 1-4-2009		John Doe			Removed !$!#$ header
** 1-5-2009		Larry Doe			Copied header to new stored procedure, 
will update someday. with new text 
** 1-6-2009		Larry Doe			Fix row of astrixes, there were 4 extra!
** 1-7-2009		John Doe			Removed all ***** ascii art
** 1-8-2009 8AM		Larry Doe			Started adding unicorn ascii art
** 1-8-2009 9AM		Larry Doe			Coffee break
** 1-8-2009 1PM		Larry Doe			Lunch break
** 1-8-2009 3PM		Larry Doe			Finished adding unicorn ascii art, golf time!
** 1-9-2009		John Doe			Removed all ***** ascii art
** 1-8-2009 8AM		Larry Doe			Added "--Get Rows" comment to all select statements
** 1-9-2009		John Doe			Removed all !#$#$ "--Get Rows" comments
*******************************************************************************/

Comments are closed.