Job Ready Java

Appendix ACode Checklist

This document can be used as a guide to help you prepare your code. Many organizations have similar lists with more detail to guide you through preparing your code before sharing with a team. Go through the items on this checklist before you consider your code to be complete.

FUNCTIONALITY

• Make sure your code compiles.
• Double-check that the application performs per specification.
• Have unit tests to verify that the application performs per specifications.
  • Use positive unit tests to exercise code as intended.
  • Use negative unit tests to intentionally misuse the code and verify robust error handling and bounds of input values.
  • Step through all possible code paths in the debugger.
• Confirm that code analysis tools in your IDE do not report warnings.

STYLE

• Use a consistent style.
  • Ensure that classes, methods, and variables are named with appropriate letter casing and code blocks are indented properly.
• Follow the Single Responsibility Principle.
  • Strive to separate large functions into collections of smaller functions that perform single tasks.
  • Strive to make classes cohesive so that each class has one area of responsibility that it handles completely.
• Use comments appropriately.
  • Use comments sparingly; intent should be clear from your naming conventions.
  • Use comments to clarify your intent if it might not be clear, for example, when there is a legitimately complicated section of code to satisfy a business rule or requirement.
  • Do not use comments ...