Make edits to Javadoc tags
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 some annotations, the IDE will usually produce a warning error.
However, the comments that developers add might be 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.
What to look for when editing Javadoc content
When you make edits to Javadoc content, look for the following:
- Missing doc. Lots of Javadoc is incomplete. Look for missing documentation.
- Consistent style. See if the existing tags follow Java’s style conventions with annotations.
- Clarity. Some descriptions are unintelligible due to the curse of knowledge (it might be hard to tell without a stronger grasp of Java)
Make some edits to the Javadoc
Make some edits to a class and method. Then regenerate the Javadoc and find your changes. See how they get rendered in the output.
102/114 pages complete. Only 12 more pages to go.
Want to buy me lunch? Click the Donate button below to donate $10 through Paypal.