Every premium and members-only resource for $9.99/month, as a no-commitment subscription. See the plans

PalateKit

Sign in
Menu

Request a resource

Describe the resource you are missing in one sentence. We will email you when it is published.

0 / 280

A page, a video or an image online.

Unlock PalateKit

Unlock everything

Plan

Paying means accepting our terms of sale.

Secure payment by Stripe. Receipts and invoices sent by email.

Welcome back

Sign in to install, download or save this resource. A free account is enough for free resources.

Javadoc best practices for Java v1.0.0

Use this resource to document or review the types and public APIs of a Java project

New

  • 496 downloads
  • 110 likes
  • 171 saves

Free

Install with the CLI

In a terminal, from the folder you want:

npx --yes palatekit@latest install javadoc-documentation-best-practices

With no option, the skill goes to ~/.agents/skills/; add --agent claude-code (or codex, cursor…) to target an agent.

First time: connect the CLI with

npx --yes palatekit@latest login

The agent writes or reviews Javadoc comments: summary sentence, @param, @return and @throws tags, and documentation for public and protected members. It avoids common pitfalls. You get consistent, useful Java documentation.

Mostly picked by

Updated November 2, 2026

Card for the “Javadoc best practices for Java” skill

Details

Works in
Install guides
Generates with
Your agent's model
Licence
MIT

Similar resources

View all

What you get

  • SKILL.md: rules for comments and tags
  • SKILL.md: anti-patterns and verification protocol

Good fit for

  • You publish a Java library with a public API
  • A code review flags public methods with no documentation

Not for

    Tags

    • java
    • javadoc
    • documentation
    • api

    About

    You say

    “Document the public API of our Java payment module with Javadoc.”

    Card for the “Javadoc best practices for Java” skill

    Skill published by practicalswan under the MIT license, delivered in its original version.

    Show more

    How to use it

    1. Install the skill in your agent's skills folder
    2. Ask your agent to document or review the types and public APIs of a Java project
    3. Review and adjust the result

    Content preview

    Files

    • CHANGELOG.md6.2 KB
    • LICENSE1 KB
    • NOTICE-PALATEKIT.md0.5 KB
    • SKILL.md4.3 KB

    Origin and licence

    Listed unmodified

    Author
    practicalswan
    Source
    github.com/practicalswan/agent-skills/tree/6cf63517700aa9ba0b80e711a93837e3bea13d0a/java-docs
    Licence
    MIT

    Notice

    « java-docs » (practicalswan, MIT) livré dans sa version d'origine : fiche en français et en anglais par PalateKit.

    User reviews

    –

    No ratings yet

    Loading reviews…

    Delete your review?

    Your rating and comment will be removed from the page.