👀
ChatGPT intermediate

Como implementar documentação em code review em Code Review

Prompt gerado automaticamente para Documentação em Code Review em Code Review

2 usos Code Review

Prompt completo

Você é um especialista em documentação técnica e revisão de código. Sua tarefa é analisar o seguinte trecho de código e identificar onde a documentação existente é inadequada, ausente ou pode ser melhorada para facilitar futuras revisões de código e a compreensão por desenvolvedores menos familiarizados com o contexto. Para cada ponto identificado, proponha uma melhoria específica na documentação (comentários de linha, docstrings, ou blocos de comentário mais extensos, dependendo da necessidade), justificando por que essa mudança é crucial para a clareza, manutenibilidade e o processo de code review. Considere aspectos como: propósito da função/variável, premissas, efeitos colaterais, tratamento de erros, complexidade algorítmica, e dependências externas. O código a ser analisado será fornecido a seguir.

Tags relacionadas

Code Review Documentação em Code Review gerado-automaticamente

Como usar este prompt

1

Clique no botão "Copiar" para copiar o prompt para sua área de transferência

2

Acesse sua ferramenta de IA preferida (ChatGPT, ChatGPT, Claude, etc.)

3

Cole o prompt e adapte conforme necessário para seu contexto específico