java-docs — Skills — getagentictools

What it does

Public and protected members should be documented with Javadoc comments.

It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory.

The first sentence of the Javadoc comment is the summary description. It should be a concise overview of what the method does and end with a period.

Use @param for method parameters. The description starts with a lowercase letter and does not end with a period.

Use @return for method return values.

Use @throws or @exception to document exceptions thrown by methods.

Use @see for references to other types or members.

Javadoc best practices for documenting Java types, methods, and members.

Source

Repository: https://github.com/github/awesome-copilot

java-docs FAQ

What does the java-docs skill do?

Ensure that Java types are documented with Javadoc comments and follow best practices for documentation. Public and protected members should be documented with Javadoc comments. It is encouraged to document package-private and private members as well, especially if they are complex or not self-explanatory.

How do I install java-docs?

Run: npx -y skills add https://github.com/github/awesome-copilot --skill java-docs --agent claude-code — the source lives at github.com/github/awesome-copilot.

Maintain java-docs?

Let people know it's listed here — add the badge (live metrics, light/dark aware) or a plain link to your README or docs.

[![java-docs on getagentictools](https://getagentictools.com/badge/skills/github-awesome-copilot-java-docs.svg)](https://getagentictools.com/skills/github-awesome-copilot-java-docs?ref=badge)

npx agentictools info skills/github-awesome-copilot-java-docs

The second line is the CLI lookup for this page — handy in READMEs and docs.