1. You must create a folder on the class server and turn in all the files mentioned below by placing them in a folder in the appropriate directory that is labeled with your last name (only). See the class server document for information on how to turn in programs. Do not compress your files!

2. You must include all .java files (not the .class files) that you use. These must be in the folder that you turn in. Do not include any .class files; I'll compile your code myself. If you import any packages (except those from the book) that are not part of standard java jdk, you must include these as a subdirectory within your turn-in directory. Do not assume that I have any packages other than the standard jdk packages and the book packages. Thus if you use packages like ICinput.java, you must include this package in your solution folder.

   You may make new directories in which to store your code, but you may not add your code to other packages (like the packages from the book). So you could make a directory called "myDir" for your program "myProg.java" if you put "myProg.java" into "myDir" and then put "myDir" in the turn-in directory. You could not put "myProg" into "utilities" (which is from the book) and put "utilities" on the server. You could import "utilities" however. Since "utilities" is from the book, you do not have to put it on the server with your other files.

3. Every java file must have a comment section at the beginning of the program that provides your name (or names), date, assignment number, and any other necessary administrative details.

4. Every java file must have a comment section at the beginning that provides an algorithm for the program.

5. Every program must have associated with it HTML documentation produced by the javadoc command. See the links page for reference material for this command. All html documentation files must be in the turn-in folder.

6. Every program must have comments in appropriate places. These comments supplement the javaDoc documentation by giving important details about the implementation of the program.

7. Every program must be accompanied by the data used to test the program and the results produced by the program on that test data. Your test data must provide statement coverage.

8. Every program must be accompanied by a README.txt file (in text format; no MS word documents) that lists the test data and the program lines that they cover. Since you must provide statement coverage, the sum of all the lines covered by the test data sets must be all of the lines in the program.

   Start the numbering of the lines in your program with "1" being the very first line in the program (even if this line is blank). Every line, including blank lines, must be numbered. Your test data obviously doesn't have to cover blank lines or comments.

Return to John Barr's Home Page

Last Modified: 14 September 2001

THIS PAGE MAINTAINED BY: John Barr, Ithaca College