Identification Header For Each Program

Example of Header

Ensure that the source code of every program contains an identification header similar to the following.

/** ==========================================================================
  * Class:    ShortEg        Kjell Exercise 8.1     Author: Student Stupendous
  * Version:  001                                      Date:  November 9, 2007
  *
  * Purpose   Experiment with values and variables of different data types.
  *
  * Course:   Computer Science 201                   Teacher:  Gerry Donaldson
  * School:   Sir Winston Churchill High School, Calgary, Alberta, Canada
  * Language: Java J2SE 6.0      Target Operating System: Java Virtual Machine
  * System:   Intel Celeron 3GHz running under Windows XP     IDE: Eclipse 3.2
  * ========================================================================*/

The program should demonstrate the use of good programming techniques. It should include an identification header indicating:

  • Program Name
  • Author
  • Course
  • Term
  • Period
  • Purpose of the Program
  • Date of This Revision
  • School, City, Province, Country
  • Computer Programming Language Used
  • Operating System Targeted
  • Development Tools (CPU and Operating System)
  • IDE (Integrated Development Environment) Used


[Counter On Strike [Home of Gerry Donaldson's Com Sci Gate]
[Gerry Donaldson's Email Address]
gerry@comscigate.com
[EFC Blue Ribbon - Free Speech Online]

On the Internet Since March 9, 1996    URL:   http://www.comscigate.com    Last Revised:   January 20, 2006.