Make edits to Javadoc tags
- Overview
- Overview of native library APIs
- Get the sample Java project
- Java crash course
- Activity: Generate a Javadoc from a sample project
- Javadoc tags
- Explore the Javadoc output
- Make edits to Javadoc tags
- Doxygen, a document generator mainly for C++
- Create non-ref docs with native library APIs
Topic 8 of 10
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 doc comments, the IDE or the Javadoc tool will often show warnings.
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.)
-
Warnings. Generate the Javadoc and read the warnings in the output. They point to missing
@param,@return, and@throwstags and to broken links.
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.
Sponsored
About Tom Johnson
I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, agent skills, tech comm careers, and more. Check out my AI courses for more on the latest in AI and tech comm. If you're looking for info about documenting APIs, see my API documentation course.
If you're a technical writer and want to keep on top of the latest trends in tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me.
Finally, I want to note a couple of things. I usually write the first drafts of my posts myself and then use AI to improve accuracy, clarity, and detail in places, so my writing is a mix of human and AI. (Hopefully that's not too off-putting.) Also, the opinions I express on my blog are my own perspectives, not those of my employer.