Complete RobotRat.java Source Code Listing


Some Final Considerations

The core development efforts are complete, but I would hesitate in calling RobotRat finished just yet. When you have finished the last integration and testing cycle you will want to revisit and edit the code for neatness and clarity. Perhaps you can do a better job of formatting the code so it’s easier to read. Maybe you thought of a few cool features to add to the project to get extra credit.

When you have reached the point where you feel you are done with the project you will want to give it one last review. Table 3-11 lists a few things to check before submitting your project to your instructor.

Table 3-1: Final Project Review Check-List

Check-Off

Double-Check

To ensure

 

Source Code Formatting

Ensure it is neat, consistently aligned, and indented to aid readability

 

Comments

Make sure they’re used to explain critical parts of your code and that they are consistently formatted. Use javadoc comments if possible.

 

File Comment Header

Add a file comment header at the top of all project source files. Make sure it has your name, class, instructor, and the name of the project. The file comment header format may be dictated by your instructor or by coding guidelines established at work.

 

Printed copies of source code files

Make sure that it fits on a page in a way that preserves formatting and readability. Adjust the font size or paper orientation ifrequired to ensure your project looks professional.

 

Class files on floppy, CD-ROM, or memory stick (i.e., removable media)

Ensure all the required source and class files are present. Try running your project from the removable media to make sure you have included all the required class files.

Figure 3-14 shows a screen shot from the automatically generated javadoc documentation for the RobotRat class.

image from book
Figure 3-14: Partial RobotRat Javadoc Documentation




Java For Artists(c) The Art, Philosophy, and Science of Object-Oriented Programming
Java For Artists: The Art, Philosophy, And Science Of Object-Oriented Programming
ISBN: 1932504052
EAN: 2147483647
Year: 2007
Pages: 452

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