Fast way to add a comment header

Fast way to add a comment header

For a rapid way to add a comment header to your code from Query Analyzer, add a "comments.tql" file to the Query Analyzer Templates sub-directory.

When you are writing your view, sprocs, or triggers in Q.A., inserting a generic comment section is simply a CTRL+SHIFT+INS keypress away. The code below is the template I use; I'm the sole developer in my shop so you may need to tweak this to your own needs.

I typical place this header directly underneath a CREATE ... statement and above any parameter declarations for the code. 

 /*************************************************************************
** Name:         Code name here
** Parameters:   Parameters here
**
** Description:  Description here
**
** Programmer:     Michael A. Garstin
** Date Written:   January 1, 2002
**
** Change History: 01/01/2002 - MAG
**                 First written
**
*************************************************************************/


    Requires Free Membership to View

    Login

    When you register, you'll begin receiving targeted emails from my team of award-winning writers. Our goal is to provide a unique online resource for developers, architects and development managers tasked with building and maintaining enterprise applications using Visual Basic, C# and the Microsoft .NET platform.

    Hannah Smalltree, Editorial Director

    By submitting your registration information to SearchWinDevelopment.com you agree to receive email communications from TechTarget and TechTarget partners. We encourage you to read our Privacy Policy which contains important disclosures about how we collect and use your registration and other information. If you reside outside of the United States, by submitting this registration information you consent to having your personal data transferred to and processed in the United States. Your use of SearchWinDevelopment.com is governed by our Terms of Use. You may contact us at webmaster@TechTarget.com.

This was first published in July 2002

Disclaimer: Our Tips Exchange is a forum for you to share technical advice and expertise with your peers and to learn from other enterprise IT professionals. TechTarget provides the infrastructure to facilitate this sharing of information. However, we cannot guarantee the accuracy or validity of the material submitted. You agree that your use of the Ask The Expert services and your reliance on any questions, answers, information or other materials received through this Web site is at your own risk.

Back to top