O que é Clean Code e Quais são Suas Regras Básicas? Descubra Aqui Blog Accurate
15 fev
Publicado em
Clean Code

O que é Clean Code e Quais são Suas Regras Básicas? Descubra Aqui

Não tem nada mais problemático do que pegar um projeto cujo código é difícil de ser trabalhado no futuro. 

Tal situação além de causar dores de cabeça pode trazer prejuízos financeiros à empresa que precisa realizar alterações ou mudanças no projeto. 

Por esse motivo, muito tem se falado sobre código limpo ou Clean Code para garantir que um projeto seja facilmente trabalhado por qualquer pessoa. 

Siga nesse conteúdo e saiba o que é o Clean Code, e quais as regras básicas de sua aplicação.

Você sabe o que é Clean Code? 

Clean Code é uma técnica essencial para garantir que projetos sejam facilmente trabalhados em manutenções e/ou alterações futuras. 

E quando digo em manutenções futuras, é aqui que está o maior dos problemas. 

Quem nunca pegou um código de algum amigo e ficou pensando: “Onde é que eu estou?”, “Que coisa é essa?” 

Sim, isso é normal quando o programador não utiliza um método eficiente de organizar o seu código e deixá-lo visível e simples de entender.

Se ainda não ficou muito claro o objetivo deste post, exemplificarei:

“Hoje criei um sistema e não revisei. Lá no futuro, o meu eu muito bem sucedido rs, contratou um outro dev para dar manutenção neste mesmo sistema. 

O programador, quando abre o código fica perdido pois, ele não entende muito bem o que é função, o que é variável no meu código, os nomes estão totalmente desorganizados e sem sentido.”

Essa é uma história inventada, mas é muito real no dia a dia. 

Acontece que muitos programadores não se importam em revisar os códigos e esquecem que um sistema nunca está totalmente finalizado.

Sempre existe a necessidade de atualizações e novas funcionalidades e alguém vai se frustrar no futuro tentando entender este código. 

Além disso, as linguagens de programação se renovam a todo instante, saindo novas bibliotecas com novas funções para melhorar e enxugar o nosso código.

7 regras básicas do Clean Code

1 – Nomes são muito importantes

As definições dos nomes dentro do nosso projeto é super importante para o bom entendimento do código. Seja ele:

  • Variável;
  • Função;
  • Parâmetro;
  • Classe;
  • Método;

Quando se define um nome no projeto devemos considerar 2 pontos principais e importantes:

  1. O nome deve ser objetivo e preciso, devendo passar de cara realmente do que está se tratando.
  2. Se o nome é grande ou pequeno isso não importa, apenas deixe claro e objetivo se colocando sempre no lugar de uma terceira pessoa.

2 – Regra do escoteiro

Essa é a que eu mais gosto pois, no meu ambiente de trabalho costumo ser exigente comigo mesmo, gosto sempre de deixar as coisas organizadas para que meus colegas consigam me ajudar da melhor forma possível.

Existe um princípio do escotismo que diz que: “uma vez que você sai da área em que está acampando, você deve deixá-la mais limpa do que quando você a encontrou”.

Trazendo para a programação, você deve deixar seu código mais limpo do que quando você pegou para programar. 

Jamais devolva um código sem revisar essa regra!

3 – Seja o verdadeiro autor do código

Sim, eu sei, você ficou perdido. Como assim ser o autor do seu código se ele é trabalhado em equipe?

Tá, esta regra realmente se aplica na autenticação das funcionalidades colocadas ali no programa. 

Cada programador trabalha de uma forma e tem suas ideias, e você precisa se preocupar em como expressar essas ideias em códigos.

Para simplificar aonde quero chegar, para estruturar um código limpo, é necessário criar funções simples, claras e pequenas.

Basicamente, as regras a serem utilizadas são:

  1. As funções precisam ser pequenas;
  2. Elas têm que ser ainda menores;

Você deve estar se perguntando: “Ele deve estar louco, no início do post ele disse que o tamanho não importava”. 

Aí eu respondo para você que a diferença é que o nome pode ser do tamanho que você quiser, mas declarar as funções de um tamanho pequeno faz toda a diferença no código e se puder diminuir ainda mais, legal!

4 – DRY (Don’t Repeat Yourself)

Em tradução livre significa: “Nunca repita a si mesmo”.

O Dry diz que cada pedaço do conhecimento de um sistema deve ter uma representação única e livre de qualquer ambiguidade, seja ele:

  • Banco de dados;
  • Testes;
  • Documentação;
  • Codificação;

Em outras palavras, não deve existir duas partes do programa desempenhando a mesma função.

5 – Comente apenas o necessário

É comum novos programadores comentarem todas as linhas para utilizarem como referência no futuro. 

Porém, em uma manutenção do sistema a coisa que não é modificada são os comentários, podendo gerar uma confusão em um futuro próximo, no entendimento do código e contextos sem sentido.

Logo, se forem comentar um código comentem somente o necessário, e lembrem-se de revisar também seus comentários.

6 – Tratamento de erros

Infelizmente, sempre teremos problemas, sejam eles em sistemas web, mobile e em geral. Porém, garanta que sua aplicação continue realizando o que se propôs a fazer.

Saiba tratar as exceções corretamente, esse é um diferencial super valioso.

7 – Testes limpos

É muito valioso testar seus códigos antes de liberá-los para a produção, ou melhor dizendo, antes de entregar seu código para cliente final. 

Só assim seu código poderá ser considerado limpo.

Para isso, existem algumas regras:

  • FAST: O teste deve ser rápido e realizado a todo o momento.
  • Independente: Delimite o código que será testado, isso evita um efeito cascata caso surja um erro, e dificulte seu entendimento do tal.
  • Repeatable: Deve repetir o teste em diversas plataformas, diversas vezes.
  • Self-Validation: Testes bem desenvolvidos retornam com respostas booleanas true e false, para que a falha não seja subjetiva.
  • Timely: Os testes devem seguir à risca o critério de pontualidade. O ideal é que sejam escritos antes do código, para evitar uma complexidade ao ser testado.

Em modo geral, este conceito está a cada dia evoluindo ainda mais, deixando os códigos mais eficientes e evitando grandes problemas e principalmente a manutenção.

Venha com a Accurate e garanta Códigos Limpos e Projetos Eficientes

Aqui na Accurate a preocupação é constante com a entrega de projetos que sejam eficientes ao cliente, e o Clean Code é uma das muitas técnicas utilizadas para isso. 

Lá no nosso site você fica sabendo mais sobre os nossos projetos e clientes.

E se você é um profissional da área de Tecnologia da Informação e está procurando uma oportunidade na área, acesse a nossa página de carreiras, veja as vagas disponíveis e envie seu currículo. 

Não se esqueça de compartilhar esse conteúdo e continuar acompanhando o Blog e as Redes Sociais da Accurate: Facebook, Instagram, Twitter, Linkedin e YouTube.

Autor

Edmundo Faria
Edmundo Faria
Graduado em Análise e Desenvolvimento de Sistemas, atua na área de tecnologia a mais de 10 anos, desempenhando papéis em infraestrutura On Premise, Cloud e atualmente no desenvolvimento de Software Web e Mobile.
, ,

Deixe um comentário

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *