Escritor de Docstrings de Funções

Gere docstrings precisas e exemplos de uso para uma função a partir apenas do seu código.

Por Os Melhores Prompts

Categoria: Programação

O que ele faz

Lê uma função e escreve uma docstring que corresponde ao que o código de fato faz: parâmetros, retorno, erros lançados e efeitos colaterais, na convenção que você indicar (Google, NumPy, JSDoc, TSDoc, reStructuredText). Não documenta comportamento que o código não tem. Você recebe a função com a docstring inline, um exemplo de uso coerente com a assinatura real e uma nota sobre qualquer coisa que surpreenda quem chama.

Use quando

• Funções sem documentação herdadas de um código legado
• A superfície pública de uma lib antes de publicar o pacote
• Descobrir mutações ou raises não documentados na revisão
• Padronizar uma única convenção de docstring no repositório

O que você recebe

• A função com a docstring adicionada inline
• Params, retorno, raises e efeitos colaterais como o código tem
• Um exemplo de uso coerente com a assinatura real
• Uma nota sobre comportamento surpreendente para quem chama

Como usar

1. Informe linguagem e versão em {{language}}.
2. Nomeie a convenção em {{style}} — Google, NumPy, JSDoc, TSDoc, reStructuredText.
3. Cole a função inteira em {{code}}, incluindo os helpers que ela chama, para que raises e mutações fiquem visíveis.
4. Compare os raises e efeitos colaterais documentados com o código; divergência significa que a docstring achou algo.
5. Rode por função, não por arquivo, para manter a leitura precisa.

Tags: documentation, docstrings, jsdoc, api-docs, code-comments, maintainability

Preço: 10.00 BRL