Please follow these guidelines in preparing your assignment files for submission:
Put the names of all students for whom the assignment is submitted (when pairs are allowed) in the file containing your Examples class.
Annotate every method get with a brief comment explaining what the method does. This is analogous to the 1101/2 purpose statement.
Provide examples of data for all classes you define. Put these in an Examples class (one Examples class per assignment/project).
Provide test cases for all of your methods. We will check that your tests are correct relative to the problem statement.
An assignment will often indicate specific methods for which we will grade your test cases particularly closely. For these methods, we will check whether your test cases detect our own set of broken solutions (by having at least one of your tests fail on our broken solution). Our broken solutions will have mistakes in the logic of the computation, but will satisfy the input and output types required by the program.
Use appropriate techniques to reuse common code.
Use newlines and indentation to produce clean code (we actually read your code, we don't just run it). Producing clean code is one of the evaluation outcomes for the course.
Submit only your .java files, not your
.class files.
You do NOT need to:
Comment individual lines within your code unless something subtle is going on.
Provide 1101/2-style templates, unless a question asks otherwise.
Include error checking (until we cover that after the midterm--assignments will indicate when error checking is expected).