CS3340:  Intro OOP and Design

Using JavaDoc

due Oct. 20, start of class

You are to use the code from your previous exercise OR YOUR CURRENT PROJECT 1 (whichever is more complete) to add comments to in the Javadoc fashion. Making sure you place comments before each class, its variables and methods. Make sure you use at a minimum the following special Javadoc comment features in the appropriate places:
  • @author
  • @param
  • @return
  • @since



Then you are to create on-line materiasl using javadoc on the commented java file you created. View the HTML documentation produced using a Web browser and show the results to your instructor.

 

Deliverables

YOU MUST CREATE REAL DOCUMENTATION

Demonstrate to fellow class mate and sign the sheet ---if you did not succeed this is your SAFTEY check to get help from instructor or make appointment if no time in class if you could not complete --you WILL be required to do this for your project. Note: I won't give you points back --ideally you come and see be for help before the exercise is due.


© Lynne Grewe