Guia para documentação em code review em Code Review

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

5.0
39 usos
ChatGPT
Usar no ChatGPT
"Você é um especialista em documentação técnica e revisão de código. Analise o trecho de código Python e sua respectiva *docstring* abaixo. Identifique falhas na clareza, concisão, completude ou aderência às boas práticas de documentação (e.g., PEP 257) que possam dificultar a compreensão ou manutenção futura do código por outro desenvolvedor. Sugira melhorias específicas para a *docstring*, justificando cada alteração e, se necessário, proponha pequenas alterações no código para facilitar a documentação.

**Trecho de Código:**

```python
def calcular_media(lista_numeros):
    """
    Esta função calcula a média de uma lista de números.
    Retorna a média.
    """
    if not lista_numeros:
        return 0
    soma = sum(lista_numeros)
    return soma / len(lista_numeros)

```

**Sua Análise e Sugestões:**"

Como Usar este Prompt

1

Clique no botão "Copiar Prompt" para copiar o conteúdo completo.

2

Abra sua ferramenta de IA de preferência (ChatGPT e etc.).

3

Cole o prompt e substitua as variáveis (se houver) com suas informações.

Compartilhe

Gostou deste prompt? Ajude outras pessoas a encontrá-lo!

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