Exemplo mínimo, completo e verificável

Como criar um exemplo mínimo, completo e verificável

Ao fazer uma pergunta sobre um problema causado pelo seu código, você obterá respostas muito melhores se fornecer um código que as pessoas possam usar para reproduzir o problema. Esse código deve ser ...

- Mínimo - Use o menor código possível que ainda produza o mesmo problema;

- Completo - Forneça todas as informações necessárias para reproduzir o problema;

- Verificável - Teste o código que você está prestes a fornecer para ter certeza de que ele reproduz o problema;

Mínimo

Quanto mais código houver para percorrer, menos as pessoas poderão encontrar o seu problema. Simplifique seu exemplo de duas maneiras:

- Reinicie do zero - Crie um novo programa, adicionando apenas o que é necessário para ver o problema. Isso é útil se você não puder publicar o código original por motivos legais ou éticos;

- Dividir e conquistar - Quando você tem uma pequena quantidade de código, mas a origem do problema é totalmente incerta, comece a remover o código um pouco de cada vez até que o problema desapareça - depois adicione a última parte de volta.

Mínimo e legível

Mínimo não significa conciso - não sacrifique a boa informação por brevidade. Use nomenclatura e recuo consistente e inclua comentários, se necessário, para explicar partes do código que possam gerar dúvida.

Completo

Certifique-se de que todas as informações necessárias para reproduzir o problema estejam incluídas.

Algumas pessoas podem estar preparadas para carregar as peças e, na verdade, testá-las para testar a resposta que elas estão prestes a postar;

O problema pode não estar na parte que você suspeita, mas em outra parte;

Se o problema exigir algum código externo, bem como algum arquivo de configuração, inclua no exemplo.

Verificável

Para ajudá-lo a resolver seu problema, outras pessoas precisarão verificar se ele funciona:

- Descreva o problema de forma clara - "Não funciona" não é uma declaração de problema. Informe qual deve ser o comportamento esperado. Informe qual é a mensagem de erro exatamente e qual linha de código a está produzindo. Coloque um breve resumo do problema na mesma mensagem do pedido de ajuda;

- Elimine quaisquer problemas que não sejam relevantes para a reprodução do problema;

- Certifique-se de que o exemplo realmente reproduz o problema! - Se você corrigiu o problema ao compor o exemplo, mas não o testou novamente, será útil saber isso antes de pedir ajuda a outra pessoa.