Programadores e Fóruns

Caros programadores utilizadores de fóruns,

Estamos aqui hoje reunidos para tratar de um assunto de estrema importância para você, e ainda maior para os infelizes aos quais você vier a pedir ajuda nos fóruns da internet… “infelizes” foi mais pra quebrar a formalidade tá… :)

Escrevi esse texto para explicar aos iniciantes na “arte de pedir ajuda em fórum” o significado de SSCCE Snipets e motivá-los a utilizar estas idéias, tanto para ajudar a si mesmo, quanto para ajudar os amigos dos fóruns que estão tentando ajudá-lo. Estas idéias estão muito bem explicadas em sites em inglês, já está mais do que na hora dos brasileiros começarem a divulgar também. E como só reclamar não adianta, cá estou eu fazendo.. ;)

Short Self-Contained Compilable Example (SSCCE), pode ser traduzido como “Exemplo Compilável Independente e Pequeno”. Temos também o snippet – “pedaço” ou “fragmento”, em português – que é a mesma idéia. Nada complicado, certo? E pra que isso serve?

SSCCE – leia-se “ski”, ou, se preferir, use o sinônimo snippet – é um programa pequeno e independente, que normalmente demonstra a falha que está ocorrendo em seu código.

Vejamos a seguir algumas dicas¹ sobre como fazer um SSCCE, lembre-se que você estará editando uma cópia do seu código, e não o original, assim poderá fazer todas as mudanças necessárias sem se preocupar em ter que desfazer depois. Então, como é um SSCCE?

  • Ele é pequeno, mas não necessariamente simples. Em sua cópia do código (seu SSCCE), procure retirar todo código que não tiver relação com o problema que está tentando resolver. Muitas vezes, neste processo, você acaba encontrando a falha do seu programa. Deixe apenas o que for realmente necessário para analisar aquele problema. Se você deixar essa tarefa para a pessoa que for te ajudar, você estará dizendo “meu tempo é precioso, o seu não”, e fica mais difícil conseguir ajudar assim.
  • Ele é independente. É possível para qualquer um pegar o código e compilar sem nenhum esforço extra, utilizando a IDE que preferir. Quase nunca o problema está onde o autor pensa que está, postar uma única linha de código e pedir ajuda é como pedir a um médico que analise a causa das suas dores de cabeça a partir de uma amostra de fio de cabelo. É uma grande perda de tempo perguntar onde está o erro sem postar um código que possa se executado para analise. O demônio está nos detalhes.
  • Ele é compilável ou correto. É claro, para ser independente, ele deve ser compilável. Não crie um programa independente e poste sem antes testar e ter certeza que é possível compilá-lo, por favor. Claro que existe aqui uma exceção, caso o problema seja exatamente um erro na hora de compilar o código. Neste caso, tenha certeza que seu SSCCE está demonstrando o mesmo erro do seu código original. Por correto entenda também organizado, formatado, comentado e com nomes simples e fáceis de analisar.

Em último caso, se você realmente não for fazer o SSCCE por qualquer motivo, o mínimo que você pode fazer é postar seu código completo. Pedir ajuda sem postar nenhum código é como pedir ajuda médica e se recusar a fazer qualquer exame.

A ideia  apesar da longa descrição, é simples e muito importante. É incrível como fazer um SSCCE ajuda as pessoas a te ajudarem. Isso se você não acabar encontrando seu erro sozinho ao fazê-lo. Sim, o SSCCE também pode ser utilizado como Método Rubber Duck! :)

Lembrando que outro termo para SSCCE é snipet, vamos popularizar estes termos pelos fórums em português também!

Referências

1 – SSCCE : Java Glossary. http://mindprod.com/jgloss/sscce.html

Anúncios

2 comentários sobre “Programadores e Fóruns

  1. Muito interessante, não conhecia esse termo.
    Acho muito importante trazer boas práticas do exterior para cá. Parabéns pela iniciativa!

    []´s

Deixe um comentário

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s