add-javadoc

v2026.09.24

Add comprehensive JavaDoc documentation to Java classes and methods. Use when documenting Java code, adding API documentation, or improving code documentation.

GitHub
Install command
npx skhub add openhands/add-javadoc
Markdown
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 @author tag if appropriate

Method-Level Documentation

For each public method:

  • Add method-level JavaDoc describing what the method does
  • Include @param tags for all parameters with clear descriptions
  • Include @return tag describing the return value
  • Include @throws tags 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.

Discovery
Tags

No tags published for this skill.

Version
Latest version metadata

Version

v2026.09.24

Published

Sep 24, 2026

Category

Uncategorized

License

MIT

Source path

skills/add-javadoc

Default branch

main

Latest commit

f02d3aa

Tree SHA

f3a3b25