Clean Code: dicas para manter o seu código limpo

Node JS

Clean Code: dicas para manter o seu código limpo

Hoje falaremos de um assunto que eu gosto muito, que é sobre o Best Seller Clean Code de Robert C. Martin, mais conhecido como Uncle Bob, um livro que é um clássico da área de programação. Nele eu aprendi lições valiosas sobre algumas práticas e sobre como manter o nosso software mais saudável possível e essas lições se complementam com os princípios do SOLID.

É importante frisar que este artigo é somente um overview sobre o conteúdo do livro e que eu recomendo fortemente que você o leia.

cleanCode-book.jpg

O que é Clean Code

No seu livro, Uncle Bob relata que com os seus vários anos de experiência, ele percebeu que o maior problema no desenvolvimento de software estava na manutenção do código. Por tanto, um código que já nasceu escrito de uma maneira ruim e que pode funcionar, no futuro vai trazer problemas e gerar prejuízos.

Dito isso, Clean Code ou código limpo não é um design partner e sim uma filosofia de desenvolvimento é o seu objetivo é facilitar a escrita e leitura de código, com simples técnicas que no final tornam fácil a compreensão de um código.

Mas como usar o Clean Code?

A maior parte do trabalho de um programador está na manutenção e leitura de código, isso consome muita mais horas do que o desenvolvimento de um código desde o início. E aí que está a chave da produtividade de um programador, em seu livro Uncle Bob afirma que “A proporção de leitura e escrita de códigos é de 10 para 1”. Isso quer dizer que os programadores passam mais tempo lendo do que codificando novas coisas.

Dentro desse contexto o Clean Code se aplica justamente em novos desenvolvimentos e na manutenção do código já existente, a fim de evitar que o código seja recomendado por um longo tempo tornando-se difícil de manter e nesses casos é melhor jogar fora e começar de novo do que prosseguir com um código ruim.

Regras gerais do Clean Code

Listei algumas boas práticas que são listadas no livro do Clean Code e que irão te ajudar a ter um código limpo.

Mantenha-se firme as convenções

Manter-se fiel às convenções que você ou sua equipe definiram para um projeto é essencial. Por tantos nomes e padrões de variáveis, funções, parâmetros, enumeradores, classes e métodos são muito importantes para o prosseguimento do projeto! Não importa se é maiúsculo ou se possui algum prefixo, só mantenha o padrão.

Mas o importante em se definir um padrão é que ele deve ser preciso e passar de cara a sua ideia central e não tema ter nomes grandes. É melhor ter algo bem descrito do que algo que seja preciso gastar um tempo para entender.

Regra do escoteiro

Talvez você já tenha ouvido aquela expressão “Ao sair mantenha o acampamento mais limpo do que quando você chegou “. O mesmo se aplica ao nosso código, sempre que você terminar a sua alteração, garanta que você deixou melhor do que havia encontrado.

Resolva o problema

Sempre tente resolver o problema de uma forma definitiva e nunca resolva superficialmente. Sabemos que na correria do dia-a-dia, temos a tendência de não resolver os problemas da forma como devem ser resolvidos e isso muitas vezes leva ao re-trabalho.

Sempre tente identificar o real problema e faça o que for preciso para resolver definitivamente.

Comente apenas o necessário

Com a dinâmica da manutenção constante do código, os comentários acabam ficando para trás e dessa forma eles deixam de retratar o que realmente está sendo feito no código.

Por tanto esse princípio diz que comentários podem ser feitos, mas somente se forem algo necessário e que seja revisado juntamente com o código.

KISS

Esse conceito eu conheci em outro lugar, mas para esse contexto é totalmente válido e ele diz Keep it Stupid Simples ou “Mantenha isto estupidamente simples”. E boa forma de tentar enxergar a solução de problemas partindo do princípio de que tudo deve ser mais simples sem tentar complicar as coisas.

Tratamento de erros

Nós sabemos que no desenvolvimento as coisas podem dar errado, mas quando isso acontece, nós somos os responsáveis por garantir que o programa irá continuar a fazer o que precisa ser feito.

Então tratar bem as exceções é uma parte muito importante do processo.

Testes limpos

Parte do processo de desenvolvimento são os testes, é essa é uma etapa muito importante, onde um código só pode ser considerado limpo após ser devidamente validado através de testes e que devem ser limpos.

Para isso existem algumas regras, que são:

  • Fast – Deve ser rápido e que possa ser realizado quantas vezes forem necessários.
  • Independent – Deve ser independente de forma que evite efeito cascata quando ocorrer alguma falha.
  • Repeatable – Repetição dos testes e ambientes distintos.
  • Self-Validation – Testes com respostas true e false, para evitar a ambiguidade.
  • Timely – Devem seguir a regra de pontualidade e preferencialmente serem escritos antes do próprio código.

Outros pontos importantes

Existem outros pontos que são importantes para se ter um código limpo e eles são:

  • Mantenha dados de configuração em alto nível;
  • Utilize polimorfismo no lugar de IFs;
  • Utilize Async como sufixo;
  • Evite configurações desnecessários que você ainda não definiu;
  • Utilize injeção de dependência;

Conclusão

O Clean Code é um conceito muito importante, ainda mais quando olhamos para metodologias de desenvolvimento ágil. Os princípios do Clean Code solucionam muitos dos problemas que encontramos na maioria dos projetos e junto com os princípios do SOLID torna-se obrigatório para qualquer programador que deseja avançar para o próximo nível.

Espero que este post tenha sido útil para você e se gostou compartilhe com seus amigos e não deixe de acessar outros conteúdos do blog.

Referências

Explore mais