CSCI-2467 Lab 7 JavaDoc, Unit Testing, and GitHub
Download the Lab7.zip starter file. Use 7zip to unzip the file using Extract Here. Open the project folder in IntelliJ.
Examine the code and try running the program. Make sure you completely understand how the program works.
Step 1 JavaDoc
Add documentation to the RPSLSpock.java source code file. Make sure that you document the class and all methods in the file. Be sure to use the following annotations:
@author for the class, list yourself as the author
@param define each method parameter
@return explain the return values of each method
Note: these JavaDoc tags and more are documented in the Schildt book in Appendix A.
In IntelliJ, if you enter /** followed by the ENTER key on a blank line preceding a method, IntelliJ will automatically generate a JavaDoc comment template for that method. Be sure and fill in additional information including purpose of the method, purpose of the parameters, and possible return values.
To verify your JavaDoc comments generate (and view) the JavaDoc documentation in an external folder. Examine the documentation and make sure it is correct. If not, fix your documentation and re-generate it. Do not turn in your assignment yet, you are not finished.
Step 2 Unit Testing
Look at the unit tests in the RPSLSpockTest folder. Try running the unit tests. Add four additional tests to the isValidPick test method in the RPSLSpockTest class. Add three tests for the other three possible valid method arguments (rock, paper, and scissors) that have not been tested.
The RPSLSpock.isValidPick() method should return false if you pass it an invalid argument (such as the String banana). Add a fourth test to verify this. Run your unit tests and make sure they work.
Other samples, services and questions:
When you use PaperHelp, you save one valuable — TIME
You can spend it for more important things than paper writing.