It’s pretty common for developers to add Javadoc tags and brief comments as they’re creating Java code. In fact, if they don’t add it, the IDE will usually produce a warning error.
However, the comments that developers add are usually poor, incomplete, or incomprehensible. A tech writer’s job with Javadoc is often to edit the content that’s already there, providing more clarity, structure, inserting the right tags, and more.
When you make edits to Javadoc content, look for the following:
Make some edits to a class and method. Then regenerate the Javadoc and find your changes. See how they get rendered in the output.
If you would like to contribute back and encourage more available content and resources, you can click the Donate button below and contribute any amount.
Get new posts delivered straight to your inbox.
© 2017, Tom Johnson