Can it help fix documentation errors?

Absolutely, it includes an error reference module specifically designed to troubleshoot and fix common JavaDoc-related warnings and formatting errors.

Does this skill support the modern @snippet tag?

Yes, it includes specific standards for implementing code examples using both @snippet and @code tags, ensuring documentation stays readable and accurate.

Does it enforce a specific tag order?

Yes, the skill provides a strict tag ordering guide (e.g., @param, then @return, then @throws) to ensure all documentation across your project is uniform.

What is the JavaDoc Claude Code Skill?

It is a specialized capability that guides Claude in writing consistent and professional JavaDoc documentation according to industry best practices and organizational standards.

Is this skill specific to a certain Java version?

While it follows standard JavaDoc conventions applicable to most versions, it includes modern patterns compatible with the latest JDK documentation features.

JavaDoc Documentation Standards

Name: JavaDoc Documentation Standards
Author: cuioss

bycuioss

0•

Learning & Documentation

Enforces professional JavaDoc standards for Java projects including class, method, and code snippet patterns.

This skill provides a comprehensive framework for generating and maintaining high-quality JavaDoc documentation within Java projects. It equips Claude with domain-specific knowledge regarding mandatory documentation requirements, proper tag ordering, and modern patterns like the @snippet tag. By leveraging this skill, developers can ensure that their codebase remains well-documented, follows industry-standard formatting, and avoids common documentation errors, ultimately improving code maintainability and developer experience.

Key Features

01Troubleshooting guidance for fixing JavaDoc errors and warnings

02Enforced tag ordering for improved consistency and readability

03Comprehensive method documentation including parameter, return, and exception tags

04Support for modern Java documentation features like @snippet and @code

050 GitHub stars

06Standardized patterns for class, interface, and enum documentation

Use Cases

01Fixing JavaDoc build warnings and errors in CI/CD pipelines

02Refactoring existing legacy JavaDocs to match modern enterprise standards

03Generating standardized documentation for new Java classes and methods

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add cuioss/plan-marshall javadoc

For use in Claude.ai and ChatGPT

Download Skill