Como implementar documentação em code review em Code Review
Prompt gerado automaticamente para Documentação em Code Review em Code Review
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
Como Usar este Prompt
Clique no botão "Copiar Prompt" para copiar o conteúdo completo.
Abra sua ferramenta de IA de preferência (ChatGPT e etc.).
Cole o prompt e substitua as variáveis (se houver) com suas informações.
Outros prompts de Code Review
Continue explorando prompts nesta categoria.
Melhores práticas de casos de uso práticos em code review para Code Review
Prompt gerado automaticamente para Casos de uso práticos em Code Review em Code Review
Guia para troubleshooting em code review em Code Review
Prompt gerado automaticamente para Troubleshooting em Code Review em Code Review
Guia para melhores práticas em code review em Code Review
Prompt gerado automaticamente para Melhores práticas em Code Review em Code Review