[CSC 204] JavaDoc on Monday

[Andrew J. Pounds]

Now that I know many of you are making progress on your Programming 
Assignment 2, I think it is time we talk about JavaDoc and how to get 
Eclipse to generate the JavaDoc for you. While I anticipate that you are 
"commenting as you go",  the JavaDoc comments often go in towards the 
end of the coding process once you have everything figured out.

Examples of how to create the javadoc comments are found on pages 89-92 
of your text but there is a more complete reference on pages A-66 and 
A-67 in the appendix.   Go ahead and comment your constructors and at 
least one accessor and mutator method so you can see how JavaDoc will 
work on your code on Monday.

By the way, the biggest problem I have with JavaDoc is CONFIGURING it to 
work with Eclipse.   This is even a problem on the machines in the 
computer science building classroom.  We'll also take care of that on 
Monday for your own eclipse environment.

Keep the questions coming!  Happy coding.

-- 
Andrew J. Pounds, Ph.D.  (pounds_aj at mercer.edu)
Professor of Chemistry and Computer Science
Mercer University,  Macon, GA 31207   (478) 301-5627
http://faculty.mercer.edu/pounds_aj

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://theochem.mercer.edu/pipermail/csc204/attachments/20140927/9eb90372/attachment.html>