Claude MarketplacesSubmit
github avatar

Java Docs

github/awesome-copilotOfficial

The java-docs skill validates that Java types and members include proper Javadoc comments and adhere to documentation best practices. It is designed for Java developers who need to ensure their code meets documentation standards for public APIs and complex internal code. The skill solves the problem of inconsistent or missing documentation by enforcing conventions for Javadoc tags, comment structure, and coverage across different access levels.

skills.sh installs
10.8K
GitHub stars
41K
last updated
Aug 21, 2026
View on GitHub

Install

$ npx -y skills add github/awesome-copilot --skill java-docs --agent claude-code

Installs into .claude/skills of the current project.

Files

Java Documentation (Javadoc) Best Practices

Principles

  • Document only what the code actually does: read the implementation, callers and tests first. Never invent behaviour, thresholds, thread-safety, nullability or exceptions you have not verified; if unsure, leave it out or ask.
  • Keep the existing documentation style of the project (language, tag order, comment form /** */ vs ///). Do not rewrite existing comments, or mass-document a codebase, unless the user asks; limit changes to the requested scope.
  • Check the JDK level (maven.compiler.release, toolchain, java -version) before using newer features, and stay within it.

Conventions

SKILL.md on GitHub

Sponsors

Promote your product hereReach 125k+ visitors monthlyPromote your product hereReach 125k+ visitors monthlyAgent CaffeineSponsoredClose your lid, come back to finished workSnugSponsoredThe clipboard manager for the AI eraPromote your product hereReach 125k+ visitors monthlyWaxSponsoredBlock anything with supervision, without erasing your iPhonePromote your product hereReach 125k+ visitors monthlyknobsSponsoredSee your site on any phone, any day, in any language

Details

Repository
github.com/github/awesome-copilot
Categories
Git & Pull Requests, Documentation, AI & Agent Building, Java & JVM

More from github/awesome-copilot

All 318

Recommended

More Git & Pull Requests
1msw-git avatarmsw-generalmsw-git/msw-ai-coding-plugins-officialFoundation skill for MSW (MapleStory Worlds). Read this FIRST before anything else in MSW.10.7Kskills.sh installs
2msw-git avatarmsw-scriptingmsw-git/msw-ai-coding-plugins-officialAuthoring MSW scripts (.mlua) plus integrated playtest and debugging. Covers mlua syntax, annotations (@Component/@Logic/@ExecSpace/@Sync), lifecycle, exec spac10.7Kskills.sh installs
3msw-git avatarmsw-defaultplayermsw-git/msw-ai-coding-plugins-officialMSW DefaultPlayer (character) management. Use the msw-general ModelBuilder to inspect/patch DefaultPlayer.model and Player.model, add/remove components, configu10.7Kskills.sh installs
4msw-git avatarmsw-searchmsw-git/msw-ai-coding-plugins-officialMSW search integration — (1) vector search for API docs and implementation guides via the msw-mcp MCP server (mlua_api_retriever / mlua_document_retriever), (2)10.7Kskills.sh installs
5msw-git avatarmsw-avatarmsw-git/msw-ai-coding-plugins-officialMSW avatar management — costume (CostumeManagerComponent, 17 slots) + animation 3-layer pipeline (StateComponent → AvatarStateAnimationComponent → AvatarRendere10.6Kskills.sh installs
6msw-git avatarmsw-combat-systemmsw-git/msw-ai-coding-plugins-officialMSW combat system integration guide. Covers the Attack→Hit pipeline, damage model, i-frame, knockback, Hit Stop, Camera Shake, Sprite Flash, SFX, death/revive, 10.6Kskills.sh installs