Profissionais TI - Pra quem respira informação

Todos nós estamos cansados de ouvir o quanto escrever um bom código é essencial para o desenvolvimento de qualquer projeto, e que caso não sigamos essa linha de pensamento teremos os ruins e velhos problemas conhecidos, como por exemplo:

Problemas com a leitura do código: um código mal escrito o torna ilegível, fazendo com que o próprio desenvolvedor que o escreve, caso volte a ler aquele trecho algum tempo depois, corre o risco de não entender o que ele mesmo havia escrito.

Problemas com manutenibilidade: um código ilegível consequentemente dificulta a manutenção e extensão das funcionalidades do sistema, fazendo com que esse processo seja complicado e desgastante para o programador que venha a executá-lo.

Já ouvi muito na faculdade a seguinte frase:

“às três da madrugada de um domingo você não enxerga mais nada” (Prof. Dr. Ítalo Vega).

Esta frase está intimamente ligada ao fato da importância de você ter um código limpo e bem escrito. Pense na seguinte situação: você procurando um bug em uma função que não foi você quem a escreveu, e às 19hrs de uma sexta-feira, em uma aplicação que entrará em produção no sábado (o que é muito comum de acontecer). Se caso o programador que tenha escrito aquela função, um simples pedaço da aplicação, não tenha se preocupado com uma boa prática em codificação provavelmente fará com que você fique madrugada à dentro lendo e relendo todas aquelas linhas até entender o que de fato elas fazem, até encontrar o erro e finalmente corrigi-lo.

Levar mais tempo para fazer manutenção significa que você gastará mais dinheiro para estender ou corrigir pequenas funcionalidades, e gastar dinheiro além do previsto é uma das coisas que nenhum gerente de projetos gosta.

Sendo assim, como podemos codificar de modo que tenhamos um código limpo, legível e produtivo?

Alguns princípios básicos envolvem:

• Escolher bons nomes para suas variáveis, nomes significativos e que estejam de acordo com o contexto empregado são tão importantes quanto todo o código escrito. Dar bons nomes as suas variáveis faz com que todos que leiam seu código compreendam o real motivo dela estar sendo utilizada, facilitando a leitura e compreensão do código.
• Uma função deve fazer apenas UMA coisa – leia isso novamente! Uma função que desempenha mais de uma tarefa torna ainda mais complexa a sua compreensão e se transforma em uma função “bombril”, um pedacinho de código com mil e uma utilidades, o que na hora da manutenção se tornará em um monstro de 7 cabeças, ou dependendo do código escrito 7^7 cabeças.
• Dar bons nomes a funções é tão importante quanto dar bons nomes a variáveis, os nomes dados a funções devem expressar literalmente o que elas fazem de modo que um programador não precise ler o código inteiro de uma função para entender o que ela faz. Um problema ainda muito encontrado são funções em que seu nome não possuí nenhuma relação com o código que descreve o seu verdadeiro comportamento, o que irá confundir o desenvolvedor que usar está função pois ele perceberá que o que ela promete cumprir não condiz com o que ela de fato faz.
• A melhor forma de darmos bons nomes a funções e variáveis é fazermos uma análise do domínio do problema que estamos tentando solucionar, assim podemos extrair boa parte dos nomes que representam de fato os elementos que usaremos para solucionarmos o problema.
• Ainda falando sobre funções um outro aspecto muito importante é o seu tamanho, funções não devem ser grandes demais e caso sejam isso é um sinal de que algo está errado. Não podemos definir exatamente o que é um tamanho bom ou o que é um sinal de que temos um problema à vista, antigamente programadores consideravam o tamanho da tela uma boa métrica para o tamanho de funções porém hoje em dia temos diversos tamanhos de monitores, o que faz com que essa não seja a maneira correta de medirmos o tamanho de uma função. Podemos considerar uma função de tamanho ideal quando a sua quantidade de linhas está na faixa de 15 a 20 linhas, o que é suficiente para desempenhar apenas uma atividade, mas é claro que em alguns momentos isso pode variar para mais ou para menos dependendo do contexto que a qual função pertence fazendo com que tenhamos que usar o bom senso.

Princípios como estes nos ajudam a desenvolver códigos de maior qualidade, fazendo com que tenhamos maior produtividade e torne prazerosa a escrita de qualquer que seja a funcionalidade que o sistema exija, influenciando na manutenibilidade e complexididade do que é produzido, ou seja, são de extrema importância em nosso dia-a-dia.

Recomendo como leitura sobre boas práticas e como escrever um bom código o livro “Código Limpo” de Robert C. Martin, este livro trata a fundo estes pontos e muitos outros considerados indispensáveis para que possamos obter um código bem escrito e funcional.

Ame o seu código, pois ele descreve o profissional que você é.

Esqueci algum princípio para código limpo? Deixe seu comentário! 🙂

Até a próxima!
@marvinferreira