add-javadoc
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
More from openhands/skills
ssh
Establish and manage SSH connections to remote machines, including key generation, configuration, and file transfers. Use when connecting to remote servers, executing remote commands, or transferring files via SCP.
477codereview-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.
119jupyter
Read, modify, execute, and convert Jupyter notebooks programmatically. Use when working with .ipynb files for data science workflows, including editing cells, clearing outputs, or converting to other formats.
88code-review
Rigorous code review focusing on data structures, simplicity, security, pragmatism, and risk/safety evaluation. Provides brutally honest, actionable feedback on pull requests or merge requests, including a risk assessment for every review. Use when reviewing code changes.
81readiness-report
Evaluate how well a codebase supports autonomous AI development. Analyzes repositories across eight technical pillars (Style & Validation, Build System, Testing, Documentation, Dev Environment, Debugging & Observability, Security, Task Discovery) and five maturity levels. Use when users request `/readiness-report` or want to assess agent readiness, codebase maturity, or identify gaps preventing effective AI-assisted development.
74security
Security best practices for secure coding, authentication, authorization, and data protection. Use when developing features that handle sensitive data, user authentication, or require security review.
69