6 10 2015

Nós programadores muitas vezes fazemos as coisas “no automático“. Saímos programando e alterando código sem pensar profundamente no que estamos fazendo. O efeito colateral dessa atitude é que o nosso código pode acabar ficando complicado, poluído e difícil de entender. Nessa transmissão que eu fiz no Periscope duas semanas atrás, eu dei três dicas rápidas para deixar o seu código mais limpo:

Dica 1 – Não deixe código velho comentado

Hoje em dia, não faz o mínimo sentido deixar código velho comentado. Isso só deixa o seu code-base mais poluído, além de muitas vezes confundir os programadores que darão manutenção no seu código. Com tantas opções de ferramentas para controle de versão disponíveis gratuitamente no mercado, é inadmissível que você esteja trabalhando em qualquer projeto profissional sem utilizar uma dessas ferramentas. O Visual Studio Online é um exemplo de ferramenta gratuita (para times de até 5 desenvolvedores) que você pode utilizar para controlar o histórico do seu código fonte, sem ter que ficar deixando código velho comentado.

Dica 2 – Não adicione comentários desnecessários

Imagine que você tem um método na sua classe chamado “SalvarFuncionario“. Aí você vai chamar esse método em algum outro lugar do seu código e você adiciona um comentário logo acima: “Salvando funcionário“. Para quê fazer isso? Já não está claro que chamar o método “SalvarFuncionario” vai fazer com que o funcionário seja salvo? Se não existe a necessidade de adicionar um comentário, ou se o código já está claro, não adicione comentário algum! O John Sonmez já escreveu um artigo muito bom sobre comentários desnecessários, confira: Why Comments Are Stupid, a Real Example.

Dica 3 – Crie classes e métodos simples

Um dos princípios do SOLID (conjunto de “regras” que definem um código de alta qualidade) é o chamado “single responsibility“. Esse princípio diz que as suas classes (e consequentemente os seus métodos) devem ter somente uma responsabilidade. Não existe um consenso de quantas linhas de código seria o limite para um método, mas, se algum método seu tiver mais do que 50 linhas, já é um sinal de alerta. Dê uma olhada nesse método e veja se ele não está fazendo mais de uma coisa (tendo mais de uma responsabilidade). Caso positivo, refatore o método, dividindo-o em sub-métodos, de forma que cada método tenha uma única responsabilidade.

Concluindo

E essas foram as três dicas que eu apresentei nessa transmissão. Não desanime se você já tiver cometido (ou ainda estiver cometendo) algum desses erros (ou todos). Eu mesmo já cometi MUITAS vezes esses erros, inclusive até pouco tempo. O importante é você se atentar para esses detalhes e se esforçar para que o seu código fique cada dia mais e mais limpo.

Me siga no Periscope!

Eu ficaria muito, mas muito, feliz se você me adicionasse no Periscope e tentasse acompanhar as minhas transmissões ao vivo. Seria muito legal se pudéssemos trocar uma ideia sobre os assuntos que eu apresento nessa plataforma que eu estou experimentando. Amanhã acontece a minha próxima transmissão, onde eu vou mostrar para você as diferenças sobre as ferramentas de geração de relatórios Crystal Reports e Report Viewer. Me siga lá e acompanhe ao vivo: @andrealveslima.

Até a próxima!

André Lima

Impressão direto na impressora com C# Report Viewer: formatações diferentes dentro do mesmo TextBox