Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign up
The file as it is now is pretty bare and needs to be well-commented. Adding these comments will make the code more readable and understandable to the user.
requirements:
Add a header to all public classes and methods
Add @return and @param where appropriate
Add a description of what the method/class does and why it is implemented
Follow oracle javadoc programming standards
Keep descriptions concise and to the point
optional:
free to add inline comments to clarify certain statements
free to add visual representation of the hash table with example cases