add-javadoc

SkillDocs & knowledge

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

Available today. Use it from your connected AI after setup.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the add-javadoc skill

What this skill tells your AI

The instructions your AI receives, as published by openhands/extensions in skills/add-javadoc/SKILL.md and read by ahel’s review.

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.

Signals

GitHub stars
143
Forks
83
Last commit
Sep 2026
Advanced
Catalog kind
skill
Gateway key
add-javadoc
Source
github.com/openhands/extensions
add-javadoc: Skill · ahel