Suggestions for Proper Commenting of Computer Code

  '
  'PROJECT TITLE
  'filename (of this code)
  'DATE
  'STUDENT NAME
  'Other particulars such such as the course or project
  '
  'Brief description of what the program does.You may also
  'specify the interfacing hardware, part numbers etc.It may
  'be advantageous to define input, process, and output.It may
  'be suitable to indicate existing problems or "bugs" that have
  'been addressed
  '
  'If it adds to the clarity describe or define variables.
  '

variable declarations here

  '
  'Brief description of what interrupt routine does
  '

interrupt routine here 

  '
  'Briefly describe the structure or way that the main program is 
  'written (or what it does).
  '

main program goes here

  '
  'Brief description of what procedure does
  '

procedure(s) go here

• note - Over commenting does not help. Generally there should be as much code as comments. Be as brief as possible but still present pertinent information.