9 princípios que você pode aplicar agora no seu código!
Tags: programming, cleancode, cleancoding, webdev
Published: 2023-05-22 20:15:55

Você sabia que a manutenção de um código é tão importante quanto sua construção? Mas para mantê-lo, algumas práticas devem ser implementadas em um time de desenvolvimento.

Você já ouviu falar da regra do escoteiro?** Você deve deixar o acampamento mais limpo do que o encontrou.** Esta regra também deve ser seguida pelo desenvolvedor que inicia a manutenção de software.

Por isso, **Clean Code é mais do que uma metodologia**. É uma filosofia amplamente utilizada nas empresas de tecnologia e startups para manter o software o mais **livre de bugs** e **atualizado** possível.

**Como foi criado?**
O livro Código Limpo: Habilidades Práticas do Agile Software introduziu o Código limpo e técnicas associadas. [Robert Cecil Martin](https://en.wikipedia.org/wiki/Robert_C._Martin) (também conhecido como Tio Bob) escreveu o livro, publicado em 2008.

Martin está na área de desenvolvimento desde os anos 1970. Ele é um dos 17 signatários do [Agile Manifesto](https://agilemanifesto.org/), escrito em 2001 e é uma declaração de idéias e princípios fundamentais para o desenvolvimento de software(Eu recomendo que você leia pois é muito utilizado pelas empresas hoje em dia).

**9 princípios do código limpo**

Tio Bob fornece pelo menos 9 bons princípios para usar Clean Code no seu livro para que seu código funcione sem problemas. São eles:

**1- Nomes significativos:** Nomes estão por toda a parte em um software. Nomeamos variáveis, funções, argumentos, classes, arquivos e diretórios. Já que fazemos muito isso, é melhor fazê-lo bem. Portanto use nomes no seu código que **revelem intenções**, que **evitem desinformação**, que sejam pronunciáveis, pesquisáveis e significativos.

**2- Seja cuidadoso com os comentários:** Nada é mais benéfico do que um comentário bem colocado. Além disso, nada é mais destrutivo do que um velho comentário grosseiro que espalha mentiras e desinformação. Portanto, **comentários nem sempre são bons**, e pode ser prejudicial as vezes. Portanto, use comentários apenas quando estritamente necessário e lembre-se de atualizá-lo sempre que fizer alterações no código.

**3- Não se repita:** Uma das mais importantes regras do Clean Code. Esse conceito mostra que não deve haver duas partes do software executando a mesma função. Toda vez que você vê duplicação no código, isso representa uma oportunidade perdida de uma abstração(ou seja, extrair esse código para uma função ou classe separada). Kent Beck também fez um dos princípios da [Extreme Programming](https://blog.devgenius.io/extreme-programming-is-it-worth-it-55a3752135ba) e se chama: “Uma vez, e apenas uma vez”.

**4- Siga padrões de código:** Os padrões tornam o código muito mais fácil de entender. Por isso, as variações de caracteres na nomenclatura, como o uso de letras maiúsculas ou minúsculas(nomePessoa, NomePessoa, nomepessoa), devem ser personalizados.

Se você está continuando um projeto que já começou, preste atenção aos padrões que foram criados e mantenha-os em suas atualizações; essa prática melhora o desempenho de outros desenvolvedores e evita problemas no sistema.

**5- A regra do escoteiro:** Eu já mencionei isso, mas deixe tudo mais limpo do que você encontrou. Não basta escrever um bom código. O código deve ser mantido limpo ao longo do tempo. O código não poderia se tornar uma bagunça se todos nós enviássemos nosso código um pouco mais limpo do que quando o vimos pela primeira vez.

**6- Manipulação de erro:** Quando nós programamos, devemos lidar com erros. As coisas podem dar errado e, quando isso acontece, somos responsáveis por garantir que nosso código execute o que deve fazer. Então, o código limpo deve ser legível, mas também robusto. Deve fazer o que foi planejado, mas se aparecer um erro, deve ser capaz de lidar com isso.

**7- Mantenha os testes limpos:** O código só é considerado limpo depois de passar nos testes. No entanto, depois que os programadores obtiverem aprovação em um conjunto de testes, eles devem garantir que esses testes sejam convenientes para qualquer outra pessoa que precise trabalhar com o código. Por exemplo, a suíte de testes não deve demorar muito para ser executada, pois se isso acontecer a equipe será desencorajada a colocar o código em testes.

**8- Mantenha funções pequenas:** A primeira regra das funções é que elas devem ser pequenas. As funções devem fazer apenas uma coisa e fazê-lo bem. Se você tiver uma função em seu código com mais de uma preocupação(ou seja, fazendo mais de uma coisa), essa função pode ser dividida em funções menores com nomes significativos. Isso torna seu código mais fácil de entender e manter no futuro.

**9- Pense no seu código como um livro:** Este último princípio é essencial para o Clean Code. Seu código deve ser fácil de ler e entender, como um livro comum. Outros desenvolvedores lendo seu código devem ser capazes de reconhecer o que cada função faz, para que cada variável é usada e a estrutura geral do sistema.

**Conclusão**
Em geral, os desenvolvedores gastam mais tempo estudando o código existente e tentando refazê-lo do que escrevendo um novo código. E, como o tempo é essencial em equipes ágeis, **é fundamental usar as melhores práticas** para ter um código limpo e facilitar o trabalhar de todos.

Em suma, um código mal projetado atenderá aos requisitos, mas inevitavelmente surgirão problemas, principalmente na hora de mantê-lo ou atualizá-lo.

Obrigado por ler!

Este artigo foi traduzido do inglês 9 clean code principles you can apply now in your code. [Clique aqui para ler o original em inglês.](https://medium.com/@danilovilhena/9-clean-code-principles-you-can-apply-now-in-your-code-a674285967b7)
Publiquei esse artigo no medium também. [Clique aqui e confira.](https://brunogaudino.medium.com/9-princ%C3%ADpios-que-voc%C3%AA-pode-aplicar-agora-no-seu-c%C3%B3digo-31e5f5c5b995)