skills.rest
jwvdvuurst
jwvdvuurstCOMMUNITY
Explore all skills by this author →
GitHub

java-docs

Write Javadoc comments for Java types following documentation best practices.

Updated Dec 26, 2025
Search Tags:#best practices#documentation#code comments#java#api docs#javadoc
One-click install
npx skills add https://github.com/jwvdvuurst/CalculatorCollection --skill java-docs-jwvdvuurst
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: java-docs
Source: https://github.com/jwvdvuurst/CalculatorCollection/tree/main/skills/java-docs
Command: npx skills add https://github.com/jwvdvuurst/CalculatorCollection --skill java-docs-jwvdvuurst

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Java codebases often lack consistent, well-formed Javadoc comments, making APIs hard to understand and maintain. This Skill provides clear rules for documenting Java types and members so generated documentation is complete and follows established conventions. ## Core Features & Use Cases - Javadoc Standards: Defines rules for documenting public, protected, package-private, and private members with proper summary sentences. - Tag Guidance: Covers correct usage of @param, @return, @throws, @see, @since, @deprecated, {@inheritDoc}, {@code}, and other Javadoc tags. - Use Case: When writing or reviewing a Java class, apply these rules to produce consistent Javadoc comments that render correctly in generated API documentation. ## Quick Start Ask the AI to add Javadoc comments to your Java class following the java-docs best practices.

Frequently Asked Questions about java-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write Javadoc comments for Java methods?▼

Start with a concise summary sentence ending with a period, then add @param tags for each parameter, @return for the return value, and @throws for exceptions. Parameter descriptions start with a lowercase letter and do not end with a period.

What Javadoc tags should I use for Java documentation?▼

Common tags include @param, @return, @throws, @see, @since, @version, @author, and @deprecated. Use {@code} for inline code, <pre>{@code ... }</pre> for code blocks, and {@inheritDoc} to inherit documentation from base classes.

Should private methods have Javadoc comments?▼

Public and protected members should always be documented. Documenting package-private and private members is encouraged, especially when they are complex or not self-explanatory.

When should I use {@inheritDoc} in Javadoc?▼

Use {@inheritDoc} to inherit documentation from base classes or interfaces when behavior is unchanged. If there is a major behavior change, document the differences explicitly instead of inheriting.

How do I document generic type parameters in Javadoc?▼

Use @param <T> for type parameters in generic types or methods, following the same conventions as regular parameter documentation.

Related Skills

Explore More Software Engineering Skills→
tttoltttol

java coding guideline

Enforce Java coding guidelines for Spring Boot and JUnit projects.

Community
Basic
mvallimmvallim
5

java-docs

Generate Javadoc comments for Java classes, methods, and interfaces.

Community
Advanced
0xRayAI0xRayAI

lint

Run node-based linting servers to enforce code quality standards.

Official
Intermediate
SpineEventEngineSpineEventEngine
2

java-to-kotlin

Convert Java source code into idiomatic Kotlin with preserved behavior and API semantics.

Official
Intermediate