Course Documentation and Test Standards

The sections below describe the documentation and test standards for CSC326. These should be followed on all deliverables for the course.

Documentation Standards

• • All non-test Java files YOU (and by YOU we mean you and your partner/team if a team assignment) write or edit MUST be Javadoced. You are NOT required to Javadoc parts of the system that you do not modify even if the documentation is incorrect.

  • We encourage the Javadoc of test classes and methods, but it is not required.

  • JSP files cannot be Javadoced. Instead we expect in-line comments (e.g., //) to clarify behavior that is not self documented. A good guideline is that sections of code with two or more nested loops or a cyclomatic complexity of 3 or more should have some in-line comment.

Testing Standards

• • Any new JUnit test class should use JUnit 4

  • Any test file with large modifications (more than 10% of the file) should be upgraded to JUnit 4.

  • All test methods (both in JUnit and httpUnit) should start with "test" (even though JUnit4 does not require the leading test).

  • All test methods should contain at least one assert* statement.

  • Each test class should contain at least one test method.

  • There should never be any of the following assert* statements (this is not an exhaustive list of bad tests). To identify these bad tests quickly, you can use the JUnit notifications in the CSC PMD Config file.

    • assertTrue(true);

    • assertFales(false);

    • assertNull(null);

    • assertEquals(1,1);