java-docs Skill (GitHub) for Claude: What It Does and How to Install It

Makes Claude write accurate Javadoc: read the code first, keep your project's style and verify with javadoc.

Installs: 10.8K; on skills.sh
Stars: 40.7K; on GitHub
Updated: Oct 2026; last repo commit

This skill sets rules for how Claude writes Javadoc. Claude has to read the implementation, callers and tests first and must not invent behavior, thresholds, thread-safety, nullability or exceptions. It keeps the project's comment style, and it does not rewrite existing comments or mass-document a codebase unless you ask.

It then covers tags and code blocks by JDK level: pre and @code for any JDK, {@snippet} from JDK 18, and Markdown /// comments only on JDK 23 or later when the project already uses them. To verify, Claude runs mvn -q javadoc:javadoc or ./gradlew javadoc and fixes the warnings it introduced.

Good for

Java developers documenting public APIs
Library maintainers keeping Javadoc warning-free
Teams on JDK 18 or later who want {@snippet} examples

Install java-docs

Claude Code

Copy this prompt.

Install the java-docs skill in Claude Code. Run this command:

npx skills add https://github.com/github/awesome-copilot --skill java-docs

Then check that it loaded and tell me how to use it.

2
Paste it into Claude Code. It shows the change and asks before running it.

Requires Node.js.

Pick one route. The skill runs Maven, Gradle or the JDK's javadoc tool in your project, so it needs a Java build on your machine and the box has no Claude app upload.

Built from the package data we hold. Not yet tested by us.

What's in the skill

When it loads

Ensure that Java types are documented with Javadoc comments and follow best practices for documentation.

Sections in SKILL.md

Principles
Conventions
Verify

Key facts

Author: github (repo owner)
License: MIT (crawl data)
Installs on skills.sh: 10,801 (Nov 2, 2026)
GitHub stars: 40,666 for the whole github/awesome-copilot repo (Nov 2, 2026)
Last repo commit: Oct 30, 2026
What it includes: 1 file: SKILL.md only (no scripts)
Needs: A Java project with Maven or Gradle and the JDK javadoc tool

What it includes

Document only what the code does; keep the project's style
Read the implementation, callers and tests first, check the JDK level, and limit changes to the requested scope.
Try: “Add Javadoc to the public methods in OrderService.”
Read · Principles
@since, @deprecated, @author and @version rules
@since only with the real version, @deprecated with reason and replacement, @author and @version only if the project already uses them.
Write · Tag conventions
pre/@code, {@snippet} and Markdown comments
JDK 18 or later can use {@snippet}, with snippet-files for examples. Markdown /// comments are JDK 23 or later only.
Write · Code blocks by JDK level
mvn, Gradle or javadoc -Xdoclint:all
Runs mvn -q javadoc:javadoc or ./gradlew javadoc, and javadoc -Xdoclint:all -d target/javadoc-check for single files.
Runs code · Verify with javadoc
Say what was documented and which commands ran
Claude lists claims it could not verify from the code.
Read · Report

From the official docs

Permissions

Low risk

What it can do

Read your data
Create and change things
Delete things
Read-only mode

Watch out for

It runs your build tool
Maven and Gradle run your project's build configuration and plugins. Use a project you trust, and review the command before you approve it. github.com

Security advisories

No published security advisories as of Nov 2, 2026.

Technical details

Turning on read-only	No read-only mode. Use version control.
Sign-in and keys	SKILL.md mentions no account or key.
Scopes	Claude edits Javadoc comments in your Java source files Claude runs mvn -q javadoc:javadoc, ./gradlew javadoc or javadoc -Xdoclint:all Single-file checks write output to target/javadoc-check

Questions

What does the java-docs skill do?

It makes Claude write Javadoc that matches what the code actually does. Claude reads the code, callers and tests first, then writes comments and checks them with the javadoc tool.

How do I install java-docs?

Use the install box at the top of this page. It needs a Java build on your machine, so there is no Claude app upload.

Will it rewrite all my existing comments?

No. SKILL.md says not to rewrite existing comments, or mass-document a codebase, unless you ask, and to limit changes to the requested scope.

Which JDK versions does it handle?

It tells Claude to check the JDK level first. Any JDK gets pre and @code blocks, JDK 18 or later can use {@snippet}, and Markdown /// comments need JDK 23 or later and are used only if the project already does or you ask.

Is it safe?

It bundles no scripts. Claude edits comments in your source files and runs mvn, Gradle or javadoc, which execute your project's build configuration. SKILL.md has javadoc write into target/javadoc-check for single files.

Information

updated Nov 2, 2026

Repository: github/awesome-copilot
Folder: skills/java-docs

github/awesome-copilot skills.sh

Sources

Docs, issue trackers and discussions this page is built from.

Show all 2

java-docs SKILL.md · github.com
awesome-copilot README · github.com