Skip to main content

Java Docs

Skill Verified Active

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

Purpose

Ensure that Java code is well-documented with Javadoc comments, adhering to best practices for clarity and maintainability.

Features

  • Enforces Javadoc for public/protected members
  • Provides guidance on documenting private members
  • Details usage of Javadoc tags (@param, @return, @throws, @see, etc.)
  • Explains handling of generic types and deprecation

Use Cases

  • Improving code maintainability through consistent documentation
  • Ensuring adherence to project-specific Javadoc standards
  • Assisting developers in writing clear and effective Javadoc comments

Non-Goals

  • Generating Javadoc comments automatically without developer input
  • Enforcing documentation for non-Java code

Installation

npx skills add github/awesome-copilot

Runs the Vercel skills CLI (skills.sh) via npx — needs Node.js locally and at least one installed skills-compatible agent (Claude Code, Cursor, Codex, …). Assumes the repo follows the agentskills.io format.

Quality Score

Verified
99 /100
Analyzed about 21 hours ago

Trust Signals

Last commit1 day ago
Stars32.9k
LicenseMIT
Status
View Source

© 2025 SkillRepo · Find the right skill, skip the noise.