Java Reference
In-Depth Information
for the assignment. We use the structure detailed in Table 2-1 throughout this topic's example
application project.
Table 2-1.
Suggested Directory Structure
Subdirectory
Recommended Use
src\
Contains all of the
.java
source files written during the course of the project.
classes\
Contains all compiled class files and any packaged JAR files. The classpath will
point to this directory when we are running our application.
bkp\
A directory to hold any files needed for backup.
tst\
Contains all of the
.java
source files written for unit-testing the project.
tmp\
A “hold anything” directory for temporary storage.
log\
A directory to store all logged output.
doc\
Holds all documentation, including Javadocs, end-user documentation, and
design decisions documentation.
High-Level Documentation
In addition to completing the code portion of the test, to pass the SCJD exam you must author
and submit several forms of documentation. At the time of writing, the following documenta-
tion is required:
•
Javadoc documentation (discussed in depth later in this chapter).
•
A plain text file named
version.txt
.
•
User instructions—unless the user instructions are built into your application and
available while the application is running.
•
A design decisions document. The design decisions document is discussed in detail in
the following section.
The
version.txt
file must contain an explanation of the following items:
•
The version of the JDK used for development
•
The development platform
This topic uses JDK version 5 and Microsoft Windows 2000.
■
Caution
There are currently several different Sun assignments in use, and instructions may vary
between assignments. Sun may also release assignments in the future with other minor differences in the
instructions. While the information in this topic will be generally applicable to any current assignment, you
must take care to read the instructions you have received from Sun carefully, and ensure that you follow
them.
