convez.ai
PluginProdutividadeIntermediário
ahnafeusa

JavaDoc Plugin para Claude Code

ahnafeusa/javadoc-plugin

Gera JavaDoc profissional em conformidade com Oracle + Atlassian

Ver no GitHub
InicialPluginScore · de 0 a 100

Plugin que gera e atualiza comentários JavaDoc seguindo as convenções consolidadas da Oracle e Atlassian, com suporte a Java moderno (records, sealed types, snippets inline). Documenta automaticamente a API pública/protegida com rigor profissional, gerando primeiro sumário, @param, @return, @throws e comportamentos de nulidade.

Instalação

$npx convez-ai ahnafeusa/javadoc-plugin

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
0
Forks
0
Acompanhando
0
Saúde
42%
Último commit
há 5 meses
Versão
—
Issues abertas
0
Contribuidores
1

Casos de uso

  • Documentar API pública em projetos Java corporativos
  • Padronizar convenções JavaDoc em equipes
  • Atualizar docs ao refatorar código Java
  • Gerar documentação de records e tipos sealed

Veredito

Ferramenta sólida e bem-pensada para documentação Java. Equilibra rigor da Oracle com praticidade, respeitando código novo (Java 25) e evitando preenchimento desnecessário. Ideal para equipes que cobram padrão profissional em docs.

README

A tradução para o português deste README ainda está na fila.

javadoc — a Claude Code plugin

Generates and updates JavaDoc comments that follow the consolidated conventions of:

It documents the full public/protected API surface with Oracle's rigor (first-sentence summaries, @param/@return/@throws, null behavior, side-effects, thrown conditions), while declining to pad trivial pure-paraphrase accessors and skipping private internals — a balanced professional application of the two standards.

What's in here

javadoc-plugin/
├── .claude-plugin/
│   ├── plugin.json          # plugin manifest
│   └── marketplace.json     # marketplace catalog (this repo is its own marketplace)
└── skills/
    └── javadoc/
        ├── SKILL.md         # the procedure Claude follows
        └── patterns.md      # full convention catalog (tags, conflict resolutions, examples)

Install

This repository doubles as its own marketplace, so installing is two steps in Claude Code:

/plugin marketplace add ahnafeusa/javadoc-plugin
/plugin install javadoc@javadoc-tools

To try it before publishing, point the marketplace at a local clone instead:

/plugin marketplace add C:\path\to\javadoc-plugin
/plugin install javadoc@javadoc-tools

Usage

Invoke the skill on whatever scope you want documented:

/javadoc src/main/java/com/example/MoneyUtil.java
/javadoc the public API in com.example.http
/javadoc the methods I changed on this branch

It accepts a single file, a class, a package, the whole tree, or the current branch diff.

License

MIT

Ver o original no GitHub

Bom para

Relacionados