Make sure you comment your code where it isn't clear what is happening. Don't go too far with this, however, and add trivial comments. If the reader needs more than 20 seconds to understand a piece of code, explain it in a succinct comment. Throughout your project, use a mix of inline, trailing, end-of-line, and javadoc comments. The point total for comments in the grading portion of the instructions understates how much poorly commented code can affect your overall grade. JavadocChapter 5, "Documentation and Javadoc Comments," explains how to use comments in your project so that you get high marks for the documentation portion of your grade.
|