java-docs
Provides best practices and guidelines for writing high-quality Javadoc comments for Java codebases.
Install
npx skills add https://github.com/github/awesome-copilot --skill java-docsStats
| Total installs | 7,744 |
| Weekly installs | 7.7K |
| GitHub stars | 27.4K |
| First seen | Feb 25, 2026 |
| Source | @github/awesome-copilot |
Summary
- Public and protected members require Javadoc comments; package-private and private members are encouraged, especially for complex code
- Use standard tags: @param for parameters, @return for return values, @throws for exceptions, @see for cross-references, and @since for version tracking
- First sentence serves as summary description and should end with a period; parameter descriptions start lowercase without periods
- Use {@inheritDoc} to inherit documentation from base classes unless behavior changes significantly, and {@code} or <pre>{@code}</pre> for inline and block code snippets
Tags
Related skills
| Skill | Installs | vs java-docs |
|---|---|---|
| context-map | 7,633 | -111 |
| azure-deployment-preflight | 8,083 | +339 |
| create-architectural-decision-record | 7,625 | -119 |
| technical-blog-writing | 7,585 | -159 |
| vscode-ext-localization | 7,582 | -162 |
FAQ
- How many installs does java-docs have?
- java-docs has 7,744 total installs and 7.7K installs this week.
- Where is java-docs hosted?
- java-docs is published by @github/awesome-copilot at https://github.com/github/awesome-copilot.
- How many GitHub stars does java-docs have?
- java-docs has 27.4K GitHub stars.
- When was java-docs first indexed?
- OrangeBot.AI first indexed java-docs on Feb 25, 2026.
- How do I install java-docs?
- Run: npx skills add https://github.com/github/awesome-copilot --skill java-docs