Essay COMP 274 Week 7 Lab Java Doc

Essay COMP 274 Week 7 Lab Java Doc

COMP 274 Week 7 Lab Java Doc

Documentation

The objective of this part of the lab is to create documentation using Javadoc for the Paddle Ball Game project from week 5. The following documentation requirements must be met:

1. All commentary must use standard JavaDoc comments and tags.
2. For every class add a class level comment including the author and the purpose of the class.
3. Where one class heavily depends on the use of an object from another class, provide a link to the other class using the @see tag.
4. For every method, add a method level comment which includes information on the purpose of the method, the method parameters, and the result returned by the method.
5. Use the javadoc command to generate HTML files for your project.
6. Use the browser to view your generated documentation to verify that all the required information for all the classes is included.

Consult the document provided describing how to export JavaDoc comments from Eclipse.

When your documentation is complete, turn in one of the following depending on what your instructor requires:

1. Print outs of all the documentation pages from the browser.
2. A Zip file containing all the documentation pages.

Deployment

Create a JAR file for the Paddle Ball Game project from week 5. The JAR file must contain all the class files needed to make the Paddle Ball Game work. Consult the document provided describing how to export a JAR file from Eclipse. To test if you have made your JAR file correctly, double click on your JAR file using Windows Explorer. The Paddle Ball Game should start running. If you are on Citrix, you will need to copy your game to a local computer before you can successfully execute it.

When you have successfully executed your JAR file, turn in a copy of your JAR file to your instructor.