Skip to main content

add-javadoc

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

Source facts

Repository
OpenHands/extensions
Last source activity
April 23, 2026 at 20:19
Detected SKILL.md language
English
Stars
167
Forks
114

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer
6 files

Showing SKILL.md

SKILL.md
Source instructions · Read-only preview
name
add-javadoc
description
Add comprehensive JavaDoc documentation to Java classes and methods. Use when documenting Java code, adding API documentation, or improving code documentation.
license
MIT
compatibility
Requires Java source files
triggers
["javadoc","java documentation","document java"]
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](references/example.md) for before/after examples.
View on GitHub