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 @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.

Expand your agent's capabilities with these related and highly-rated skills.

OpenHands/extensions

releasenotes

Generate formatted changelogs from git history since the last release tag. Use when preparing release notes that categorize changes into breaking changes, features, fixes, and other sections.

78 21
Explore
OpenHands/extensions

bitbucket

Interact with Bitbucket repositories and pull requests using the BITBUCKET_TOKEN environment variable. Use when working with code hosted on Bitbucket or managing Bitbucket resources via API.

78 21
Explore
OpenHands/extensions

add-skill

Add an external skill from a GitHub repository to the current workspace. Use when users want to import, install, or add a skill from a GitHub URL (e.g., `/add-skill https://github.com/OpenHands/extensions/tree/main/skills/codereview` or "add the codereview skill from https://github.com/OpenHands/extensions/"). Handles fetching the skill files and placing them in .agents/skills/.

78 21
Explore
OpenHands/extensions

flarglebargle

A test skill that responds to the magic word "flarglebargle" with a compliment. Use for testing skill activation and trigger functionality.

78 21
Explore
OpenHands/extensions

codereview-roasted

Brutally honest code review in the style of Linus Torvalds, focusing on data structures, simplicity, and pragmatism. Use when you want critical, no-nonsense feedback that prioritizes engineering fundamentals over style preferences.

78 21
Explore
OpenHands/extensions

azure-devops

Interact with Azure DevOps repositories, pull requests, and APIs using the AZURE_DEVOPS_TOKEN environment variable. Use when working with code hosted on Azure DevOps or managing Azure DevOps resources.

78 21
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results