VisualBASIC Resources

Home | About | VB Tutorials | Programming Basics | VCE & Teacher�s Resources

Programming Basics

Comments

Comment everything.� Or else you won�t know what it does six months later.� Comments are a reminder to the reader of a program, so the more detailed the comment, the better its purpose.� Comments should describe in simple terms what the following piece of code does.� It is important to indicate how the decision-making is performed with the comments.� Comments should also state the reason or rationale for doing things a certain way.

At the start of a program your comments should cover the following:

• The program�s name (useful when you print it out)
• The programmer�s name (good for finger pointing)
• The date of revision (to find out how old it is)
• The version (including notes on what was revised)
• A description of what the program does (so it is not a complete black-box)
• The program�s input (what it needs)
• The program�s output (what it spits out the other end)

top

Last updated 2006.10.04

About Us | Contact Us | � 2006 Sunfire Knights Publishing