In this mini-lab, you will look at the javadoc comments that precede method definitions, including how they specify what parameters a method expects to receive and what type of value (if any) a method returns.
In this mini-lab, you will look at the javadoc comments in
Clock class from the Timestamp Mini-Lab or the
and compare the comments in the class to its class documentation.
(The class documentation for a class is the page you see when you
choose Documentation rather than
Source Code in the upper-right corner of a BlueJ editing window.)
documentation is generated from source code, similar to how compiled
code that the computer can read is generated from source code.
Remember that javadoc comments are ones that start with a
Clockclass, which you can find in either the Timestamp project or the TalkingRobot. Use the pull-down menu in the upper-right corner of the editor window to see how you can switch between the source code and the class documentation for the class.
addTestCasemethod come from?
addTestCasemethod? Where does the extra information in the Detail come from? What about for the
getHHmethod: what is the difference between the Summary and Detail information, and where does the extra information come from?
changeTimemethod: what is the difference between the Summary and Detail information? What is your hypothesis for what the javadoc tool chooses to include in the Summary vs what it includes in the Detail? Temporarily modify the javadoc comment for some other method to test your hypothesis.
@) you've seen in this class, along with what affect they have on the generated Documentation, and where.
Submit your Analysis Questions to Moodle.