CS 50, Winter 2010

Assignment 4
Implementation and Javadocs, Current Iteration

Read all instructions first.
Be sure to set up directory structures as required.
Where the instructions ask you to turn in source code, please just turn in the .java files (in appropriate directories to match their packages), and not including svn-generated or other unnecessary files.
  1. Implement the system for the current development iteration - i.e., write the necessary Java source code, and get it working well enough to demonstrate all of its current functionality. Keep in mind that you may be presenting this version to the class for assignment 5.
  2. Create the javadocs and post them online.
  3. Fully test the system. Do both unit and integration testing, and test overall functionality. (Note - any "test drivers" and "stubs" used for unit testing must not be included with the system that you turn in.) Verify the javadocs are complete and correct too.
  4. Make an appointment to demonstrate the working system to your TA. This demonstration must take place before or at the time you turn in your system.
  5. Turn in source code, data, and a read-me file before 5:00 pm, Friday, February 19.
    1. Source code files must be stored separately under a directory named "src" in subdirectories that correspond to your system's packages, either physically on a disk or logically in a zip (or jar or tar) file. No compiled class, javadoc (html) or data files should reside under src.
    2. All necessary data files must be turned in too - any data, graphics, sound, or other files necessary to compile and/or execute the system.
    3. Include a file called README.txt in the root of this file structure.
      • The file must list precise instructions to compile and execute your system. Include any necessary details about where to store data files too. If you provide an Ant build file to perform any steps, store it in the root directory and say how to use it.
      • Also state the complete URL for your javadocs' main index.html file. The instructor will post a link to this URL on the course's project page.
    Consult your TA about where and how you should transmit these materials to her.

Updated January 29, by C. Michael Costanzo

CS 50 homepage