🎯

java-docs

🎯Skill

from github/awesome-copilot

What it does

Ensures Java types are documented with Javadoc comments following best practices, including summary descriptions, parameter tags, and proper formatting for public and protected members.

Overview

This skill ensures Java types are properly documented with Javadoc comments following established best practices. It covers documentation standards for public and protected members including summary descriptions, parameter tags, return values, exception documentation, cross-references, and proper formatting for inline code and code blocks.

Key Features

Javadoc Standards - Enforces proper use of @param, @return, @throws, @see, @since, @version, @author, and @deprecated tags following Java documentation conventions
Summary Description - Guides first-sentence summary writing as a concise overview ending with a period, which becomes the primary description in generated documentation
Generic Type Documentation - Supports @param <T> for type parameters in generic types and methods, ensuring type-safe code is properly documented
Code Formatting - Uses {@code} for inline snippets and <pre>{@code ...}</pre> for code blocks to ensure proper rendering in Javadoc output
Inheritance Support - Applies {@inheritDoc} for inherited documentation from base classes or interfaces unless behavior differs significantly

Who is this for?

Java developers who need to maintain consistent Javadoc documentation across their codebases. Ideal for library authors, API developers, and teams following code documentation standards where proper Javadoc comments are essential for generated API documentation and IDE developer experience.

📦

Same repository

github/awesome-copilot(315 items)

java-docs

Installation

Vibe Index InstallInstalls to .claude/skills/ - auto-recognized by Claude Code

npx vibeindex add github/awesome-copilot --skill java-docs

skills.sh Install⚠ Installs to .agents/skills/ - may not be auto-recognized by Claude Code

npx skills add github/awesome-copilot --skill java-docs

Manual InstallCopy SKILL.md content and save to the path below

~/.claude/skills/java-docs/SKILL.md

SKILL.md

9,374Installs

AddedFeb 25, 2026

View on GitHub Back to Skills

More from this repository10

🎯

git-commit🎯Skill

A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.

🎯

gh-cli🎯Skill

A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.

🎯

prd🎯Skill

Generates comprehensive Product Requirements Documents (PRDs) by systematically analyzing requirements and crafting detailed technical specifications

🎯

documentation-writer🎯Skill

Expert technical writer guided by the Diataxis framework, creating tutorials, how-to guides, reference docs, and explanation pages for software documentation.

🎯

excalidraw-diagram-generator🎯Skill

Generates Excalidraw diagrams from natural language descriptions, creating visual representations of processes, systems, relationships, and ideas.

🎯

refactor🎯Skill

A community-curated collection of custom agents, prompts, instructions, and skills to enhance GitHub Copilot across different domains, languages, and use cases.

🎯

java-springboot🎯Skill

Provides Spring Boot best practices covering project setup, dependency injection, REST API design, data access with JPA, security configuration, and testing strategies.

🎯

multi-stage-dockerfile🎯Skill

Creates optimized multi-stage Dockerfiles for any language or framework, separating builder and runtime stages to produce smaller, more secure container images.

🎯

create-readme🎯Skill

Creates README.md files for projects.

🎯

memory-merger🎯Skill

Merges mature lessons from domain memory files into instruction files, consolidating knowledge with minimal redundancy across global, user, and workspace scopes.