The following headers are to increase the readability of your code and provide code documentation. These headers will be inserted at the start of your source files as well as before any functions you have defined. Thus, going through your code will be easy for the grader and it will be easier to detect any errors in your code and help it make more modular. Also, code maintenance becomes an easier task. These headers are inserted as comments in your file. The following four headers are defined : 1) Source File header: insert at the start of each source file i.e. *.c file for C Programmers and *.cpp for C++ programmers. /************Start of Source File Header***********************/ /*Source File Name: sort.c (Replace this by the name of the current source file) Author: Kamlesh Talreja (Replace this by the name of the author i.e yours) Created on: 2/6/98 (Replace this by the date created on) Last modified : 2/7/98 Purpose : Give a high level description of the classes (for C++ programmers) or functions implemented in this file Classes/Functions defined: Name of classes/functions defined in this file */ 2) Header File header: insert at the start of each header file i.e. *.h files /************Start of Header File Header***********************/ /*Header File Name: sort.h (Replace this by the name of the current header file) Author: Kamlesh Talreja (Replace this by the name of the author i.e yours) Created on: 2/6/98 (Replace this by the date created on) Last modified : 2/7/98 Purpose : Give a high level description of the classes (for C++ programmers) or functions declared in this file Classes/Functions defined: Name of classes/functions declared in this file */ 3) Class header(for C++ Programmers only) : insert at the start of each class definition /************Start of Class Header***********************/ /*Class Name: CFile (Replace this by the name of the your defined class) Purpose : Give a high level description of the class and the purpose for which the class has been written Implementation File: file.cpp (Replace this by the name of the file where the class has been implemented Constructors: The constructors defined for this class and the parameters they take */ 4) Function/Method header: insert before each method or function implementation /************Start of Function/Method Header***********************/ /*Function Name: ReadInput (Replace this by the name of the function) Arguments: Describe the type and purpose of the formal parameters to this function Returns: Describe the type and condition under which the particular output is returned (for e.g. Returns: boolean, true if readinput succeeds and false if it fails) Purpose : Give a high level description of what the function does */