👀
ChatGPT intermediate

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

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

4 usos Code Review

Prompt completo

"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:**"

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