Clean Code

Olá, hoje vamos falar sobre codificação limpa ou Clean Code.

No decorrer da minha carreira, já me deparei com varias situações onde precisei analisar ou dar manutenção em softwares desenvolvidos por outras equipes. E por mais triste que seja devo dizer, na maioria delas não foi muito agradável saber que o desenvolvedor não foi tão cuidadoso ao escrever o código, por simplesmente ignorar algumas das boas praticas na hora de codificar software.

Quando codificamos devemos ter em mente que codificamos para alguém, pois além do produto de software atingir o objetivo funcional e de usabilidade também deve manter um nível de qualidade em sua codificação, pois ele pode sofrer mudanças ao passar do tempo e a manutenção do mesmo será inevitável. É primordial que os desenvolvedores usem técnicas para deixar o código mais limpo e de fácil leitura, pois outros companheiros de trabalho poderão identificar com mais facilidade tudo que o código se propõe a fazer.

Nada como abrir o código fonte e se deparar com código legível bem estruturado e coeso sem falar de comentários bem escritos em lugares apropriados.

Bom, para que isso seja possível existem práticas que ajudam no nosso dia a dia.

Vamos ver algumas delas:

Usabilidade: Codifique sempre pensando em usabilidade, isto é, como o usuário vai utilizar este software. Muitas vezes esta pergunta facilita e tira o desenvolvedor de enrascadas como a implementação de códigos que no futuro próximo perdem o sentido.

Integridade: Pense no baixo nível de acoplamento e alto nível de granularidade, isto é, mantenha um código coeso e enxuto, pois isso faz toda a diferença.

Simplicidade: Na hora de escrever um código sempre pense na solução mais simples possível, não esqueça de que você não deve assumir para seu código mais responsabilidades do que ele deve fazer. Não esqueça “menos é mais”.

Padrões: Não tente reinventar a roda utilize Design Patterns, pois são eles que vão manter seu código coeso e com alto nível de reaproveitamento. Os padrões são soluções para a maioria dos problemas que enfrentamos no dia a dia.

Refatoração: Sempre que implementar algo, leia tudo após terminado e veja o que pode ser melhorado. Esta técnica proporciona maior visibilidade e nos monstra detalhes que na primeira vez passa despercebido. Quem nunca olhou um código antigo feito por você mesmo e pensou “Nossa onde eu estava com a cabeça quando fiz isso”.

Comentário: Sempre comente seu código se forma objetivo, mais cuidado, não vá pecar pelo acesso. Descreva somente aqueles métodos que não são óbvios.

Legibilidade: Nome de variáveis e métodos devem sempre ter certo significado, ou seja, ter alguma coisa a ver com o que eles devem fazer naquele contexto.

Guia de estilo: Um programador sempre tem suas próprias regras de formatar um código, mas quando trabalhamos em uma equipe o que deve prevalecer e o padrão adotado por ela.

Para facilitar isso, podemos muitas vezes recorrer aos guias de estilos disponibilizados pelos próprios fornecedores da linguagem como, por exemplo, o guia de estilo fornecido pela própria equipe da Embarcadero para desenvolvimento Delphi: Object Pascal Style Guide.

Bom, é isso ai pessoal até mais.