Chapter 5. Documentation and Javadoc Comments


Terms you'll need to understand:

  • Design choices

  • Javadoc

Techniques you'll need to master:

  • Writing javadoc comments in Java source code files

  • Making key design decisions and justifying them

  • Writing a README.TXT file to be included in your project

In this chapter, you review the documentation required for a successful project submission. Documentation is often the last thing a developer thinks about; however, documentation, or a lack of it, affects a product's useability, acceptance, and effectiveness. Good documentation increases user understanding and, in this case, your grade.

There is no reason to lose points on this portion of the assignment. The documentation is part of development. Many developer shops don't think of it that way, but the best ones integrate documentation development with software development. For your project, you need to inform the evaluator of how you designed your solution and demonstrate that you know how to document code properly. There are two parts to this requirement. The first part is the javadoc comments that go in your source code. The second part requires three documents: the README.TXT file, the DESIGN_DECISIONS.TXT document, and user help.



JavaT 2 Developer Exam CramT 2 (Exam CX-310-252A and CX-310-027)
JavaT 2 Developer Exam CramT 2 (Exam CX-310-252A and CX-310-027)
ISBN: N/A
EAN: N/A
Year: 2003
Pages: 187

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net