Documentation

ID Block Sample:

/****************************************************************/

/* Author: Student A. Kutztown */

/* Course: CISxxx 010 */

/* Assignment: #1 */

/* Due Date: February 18, 20xx */

/* Filename: test.cpp */

/* Purpose: This program will do something somewhere */

/* To something somehow */

/****************************************************************/

MUST DOCUMENT EVERY FUNCTION!

Do documentation with definition

Include:

Function name

Brief description, task or purpose of function

Parameters (include all parameters to function; if no parameters, indicate none)

Return Value (include the return value from function; if no return value, indicate none)

Example of Function Documentation:

/*********************************************************************/

/* */

/* Function name: calcTotal */

/* */

/* Description: Get input from user */

/* */

/* Parameters: int num_days - INPUT - # of days in hospital */

/* char room_type – INPUT - type of room */

/* char phone_use – INPUT - use telephone? */

/* char tv_use – INPUT - use television? */

/* */

/* Return Value: none */

/*********************************************************************/