Agent skill
add-javadoc
Add comprehensive JavaDoc documentation to Java classes and methods. Use when documenting Java code, adding API documentation, or improving code documentation.
Stars
78
Forks
21
Install this agent skill to your Project
npx add-skill https://github.com/OpenHands/extensions/tree/main/skills/add-javadoc
SKILL.md
Add comprehensive JavaDoc documentation to all public classes and methods.
Class-Level Documentation
For each public class:
- Add class-level JavaDoc describing the purpose and responsibility of the class
- Include
@authortag if appropriate
Method-Level Documentation
For each public method:
- Add method-level JavaDoc describing what the method does
- Include
@paramtags for all parameters with clear descriptions - Include
@returntag describing the return value - Include
@throwstags for any checked exceptions
Style Guidelines
- First sentence should be a concise summary
- Use HTML tags sparingly (prefer plain text)
- Document preconditions and postconditions when relevant
- Include code examples with
{@code ...}for complex methods
See references/example.md for before/after examples.
Didn't find tool you were looking for?