https://github.com/oiricaud/javadoc-and-unit-testing
In this assignment, you are going to improve your project by providing more feature implementation, improve documentation using Javadoc, and improve code quality by writing unit test cases using Junit.
https://github.com/oiricaud/javadoc-and-unit-testing
javadoc object-oriented school-project unit-testing
Last synced: 9 months ago
JSON representation
In this assignment, you are going to improve your project by providing more feature implementation, improve documentation using Javadoc, and improve code quality by writing unit test cases using Junit.
- Host: GitHub
- URL: https://github.com/oiricaud/javadoc-and-unit-testing
- Owner: oiricaud
- Created: 2016-11-16T19:26:29.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-17T02:54:32.000Z (about 9 years ago)
- Last Synced: 2025-01-17T18:04:09.783Z (11 months ago)
- Topics: javadoc, object-oriented, school-project, unit-testing
- Language: Java
- Size: 156 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
We divided the assignment into 3 different folders, each folder are independent from each other. In other words, each folder contains a unique use case we have identify for our project (Read Task 3 for more info)
In each of these folders we successfuly included the Javadoc and JUnit cases (Task 1 and Task 2).
Below you can find the assignment that was assign to our group. Contributors are Jessica Dozal and Marina Chong.
Javadoc & Unit Tests
Due November 17th by end of day on Blackboard
In this assignment, you are going to improve your project by providing more feature implementation, improve documentation using Javadoc, and improve code quality by writing unit test cases using Junit.
Task 1: Javadoc Refer to the Javadoc lecture notes, and Javadoc help and examples available online (for example: http://www.oracle.com/technetwork/articles/java/index-137868.html). Add Javadoc features to your project and satisfy the following:
For each class, document the author, the version
For each method, document parameter details.
Describe the return value for methods that have a return value (other than void return type)
Document Packages and Class usage
Use @see to refer to another method or class, as appropriate
Submission Guidelines 1. Java source code with Javadoc annotations. 2. Generated Javadoc documentation.
Task 2: Junit tests Refer to the Junit topic discussed in class, and to Junit best practices available online (for example: http://www.kyleblaney.com/junit-best-practices/). Add Junit test cases to your project satisfying the following.
At minimum, utilize the following assert statements as appropriate: a. assertEquals(a,b) b. assertFalse(a) c. assertNotSame(a, b) d. assertNull(a) e. assertSame(a,b) f. assertTrue(a)
At minimum, each method should be tested using two assert statements.
At minimum, each implemented use case should be tested using two Junit test cases.
Submission Guidelines 1. Java source code with Junit tests. 2. Sample runs showing Junit test results.
Task 3: Implement 3 use cases you have identified for your project.
Chose three use cases that you have identified for your project and implement them in Java. Include the implemented use cases in your submission.