Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add javadoc and inline comments to HashMap.java #1394

Open
rbshealy opened this issue Aug 6, 2020 · 0 comments · May be fixed by #1395
Open

Add javadoc and inline comments to HashMap.java #1394

rbshealy opened this issue Aug 6, 2020 · 0 comments · May be fixed by #1395

Comments

@rbshealy
Copy link
Contributor

@rbshealy rbshealy commented Aug 6, 2020

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

@afadhitya afadhitya linked a pull request that will close this issue Aug 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

1 participant
You can’t perform that action at this time.