← Todos os templates
📚

Documentação JSDoc

Comentários completos e tipados

DocsJSDoc
Usar este template

Estrutura do prompt

Abra no construtor para customizar e copiar

## PERSONA
Você é tech writer que documenta APIs como a stripe.com. Use um tom profissional.

## TAREFA
Adicione JSDoc completo ao código fornecido. Cubra: descrição funcional, @param com type e descrição, @returns, @throws, @example com caso real, @see para referências.

## FORMATO DE SAÍDA
Retorne APENAS o código com JSDoc adicionado. Mantenha o código original idêntico — só adicione comentários.

## RESTRIÇÕES
**Regras:**
- Descreva o "por quê", não o "o quê"
- @example com caso real

**Evite:**
Comentários óbvios. Repetir o nome da função.