Se você já se aventurou pelo mundo da programação, com certeza já deve ter se perguntado o que é Clean Code. Afinal, esse é um termo bastante comentado, sobretudo por conta de quem o cunhou.
“Clean Code” vem do livro Clean Code: A Handbook of Agile Software Craftsmanship, do autor Robert C. Martin. Ele é um dos co-autores do Manifesto Ágil, que define valores e princípios para uma metodologia específica de desenvolvimento de software.
Por ser uma postura buscada por muitas empresas, a metodologia ágil de desenvolvimento está bastante presente no dia a dia de programadores. Com isso, o Clean Code também faz parte de muitas discussões.
Neste artigo, você saberá:
- o que é Clean Code e por que você deve aprender como usar?
- o que é um código ruim?
- o que é um código limpo?
- como escrever um código limpo?
O que é Clean Code e por que você deve aprender como usar?
Para responder o que é Clean Code, é preciso voltar a algumas premissas do desenvolvimento de softwares. A mais relevante é que uma aplicação nunca estará completamente finalizada e, por isso, diversos programadores deverão alterá-la e melhorá-la ao longo do tempo.
Dessa forma, um código que não foi desenvolvido de maneira limpa — seguindo os preceitos do Clean Code — acaba ficando obsoleto. Afinal, se as pessoas que precisam editar aquele software não conseguem entender o que está escrito, como a melhoria poderá ser aplicada?
Assim, a prática do Clean Code busca criar códigos:
- limpos;
- testáveis;
- fáceis de ler, compreender, modificar e manusear.
Por mais que um código ruim — ou seja, um que foi escrito sem os preceitos do Clean Code — possa funcionar, o trabalho de qualquer equipe de desenvolvimento para buscar corrigir erros, implementar atualizações ou até mesmo estudar certo software acaba sendo exponencialmente aumentado.
Para esclarecer melhor a questão, vamos entender qual a diferença entre um código ruim e um código limpo. Confira!
O que é um código ruim?
Um código ruim ou sujo é qualquer código que gere obstáculos desnecessários e atrasos no trabalho de desenvolvedores.
Normalmente, segundo Robert C. Martin, esses códigos são escritos na pressa e sem atenção a erros menores. Assim, todos esses problemas passam para a versão final do software e, no momento da manutenção ou atualização, acabam sendo um problema bem maior.
O que é um código limpo?
O aspecto principal para definir o que é Clean Code no desenvolvimento de um software é que o código seja legível. Além disso, simplicidade e funcionalidade também são características importantes.
Uma dica importante para verificar a legibilidade do seu código é fazer pausas entre o desenvolvimento. Esse tempo pode ser de algumas horas ou até de semanas, a depender do que a data de entrega do projeto permitir.
Aqui, o que importa é que você deve voltar para o código já tendo “esquecido” dele, para verificar se consegue entendê-lo. Se não conseguir, quer dizer que ele precisa ser repensado. Mas, se compreender, parabéns! Você acertou o que é Clean Code.
Como escrever um código limpo?
Para aplicar as boas práticas do Clean Code, você deve sempre ter em mente que o seu código será lido por outra e que ela precisa entender o que foi escrito.
Para te ajudar a entender melhor o que é Clean Code e como usá-lo, conheça estes sete pilares da filosofia do código limpo:
1. Nomes claros e objetivos
Todos os componentes do código devem ter nomes autoexplicativos e que sejam claros no que designam. Isso significa pensar nos nomes de:
- variáveis;
- métodos;
- parâmetros;
- classes;
- funções;
- diretórios;
- branchs do controle de versão;
- projetos;
- objetos, etc.
Existem dois preceitos básicos para isso: a nomenclatura deve deixar claro o propósito daquele componente e devem ser passíveis de busca. Então, nada de abreviações, siglas ou outros tipos de nome. Qualquer desenvolvedor que acessar o seu código deve ser capaz de buscar o que deseja ver.
2. Padronizar o código
Códigos padronizados são mais fáceis de entender por seguirem uma lógica, especialmente quando é desenvolvido por mais de uma pessoa.
Um exemplo disso é usar letras maiúsculas ou minúsculas na nomenclatura de maneira uniforme. Entre as variáveis “nomePessoa”, “NomePessoa” e “nomepessoa”, deve-se escolher apenas uma para o código inteiro.
3. Programe em blocos
A programação em blocos torna seu código amigável visualmente. Aqui, o objetivo é pensar de maneira bastante geral sobre a programação, como se o sistema funcionasse como um quebra-cabeça.
Assim, cada comando seria uma peça e, com várias dessas, teríamos um bloco de código que faria o programa funcionar ou, ao menos, desempenhar certa ação.
Isso, além de tornar o código mais acessível para outras pessoas, também educa seu cérebro a trabalhar com a lógica de programação para desenvolver algoritmos mais assertivos.
4. Evite muitas repetições no código
Esse princípio também é conhecido como DRY (“Don’t Repeat Yourself”, ou não se repita). Funções com muitas linhas ou sequências de muitos “ifs” — condições para que a função ocorra — podem gerar ambiguidade.
Se esse tipo de elemento está muito presente no seu código, pode ser um bom momento para rever a função.
5. Tome cuidado com os comentários no código
Apesar dos comentários parecerem de grande ajuda para que outras pessoas entendam o código, eles podem se tornar obsoletos depois de muitas atualizações, já que as funcionalidades mudam e, com isso, o que foi desenvolvido também.
Comentários devem, portanto, serem utilizados apenas quando estritamente necessário e também atualizados. Se o seu código precisa de muitas explicações para outros desenvolvedores lerem, talvez ele não esteja dentro de o que é Clean Code, certo?
6. Trate erros
Mesmo erros menores não podem passar durante o desenvolvimento. Essas falhas, se acumuladas, podem gerar interrupções totais no software, o que prejudica os resultados de qualquer empresa.
Por isso, é sempre necessário cuidar dos erros detectados o mais rápido possível.
7. Execute testes limpos
Testes são parte do cotidiano de qualquer desenvolvedor. Afinal, é preciso ter certeza de que a aplicação está funcionando corretamente.
Testes limpos são:
- rápidos: como é um processo repetitivo para cada nova adição ao código, ele precisa ser ágil;
- independente: testar qualquer parte da aplicação não pode impactar o sistema inteiro;
- passíveis de validação: isso significa que o teste precisa retornar respostas true or false, sendo bastante objetivo;
- pontuais: muitas vezes, recomenda-se que os testes sejam escritos antes mesmo do código, para que ocorram pontualmente.
Seguindo esses direcionamentos, você consegue entender o que é Clean Code e aplicar aos seus próprios projetos. Desse modo, garante-se que qualquer aplicação que desenvolver consiga receber contribuições e atualizações de outros desenvolvedores sem grandes problemas.
Agora que você já sabe o que é Clean Code e quais seus princípios, que tal colocar o que aprendeu em prática com a melhor linguagem de programação para sites? Assim, você não só treina uma nova maneira de lidar com seus códigos, mas também conhece mais um pouco sobre desenvolvimento web!
