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.

Sign up for GitHub

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

Jump to bottom

Write JavaDoc the right way #248

Open
FanJups opened this issue Jun 24, 2023 · 0 comments
Open

Write JavaDoc the right way #248

FanJups opened this issue Jun 24, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation information good to know jsgenerator Related to the whole Project

Comments

@FanJups
Copy link
Member

FanJups commented Jun 24, 2023 •
edited
Loading

Great advice from Ken Fogel

https://twitter.com/omniprof/status/1672328157926391809?t=upNMd6j1_ieYJiEh_HRcww&s=19

For once & for all, JavaDocs for an API without code samples for each & every method, interface, class, etc. is an abomination. When I read documentation that refers me to the API's JavaDocs I know I am in for a disappointment.
@FanJups FanJups added documentation Improvements or additions to documentation jsgenerator Related to the whole Project information good to know labels Jun 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation information good to know jsgenerator Related to the whole Project
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@FanJups