Clean Code: será que você está seguindo as boas práticas?
Os escoteiros possuem uma regra que diz que, antes de desmontar o acampamento, eles precisam deixar o lugar mais limpo do que estava quando eles chegaram. Pode parecer estranho, mas essa premissa também vale para programação. Pelo menos, é isso que defende Robert C. Martin em seu livro Clean Code: A Handbook of Agile Software Craftsmanship, considerado um dos maiores clássicos do desenvolvimento.
Carinhosamente conhecido na comunidade tech como Uncle Bob, Robert Martin é um dos co-autores do consagrado Manifesto Ágil e um defensor assíduo de códigos limpos. Segundo ele, “tornar seu código legível é tão importante quanto torná-lo executável”.
Para comprovar essa teoria, “Bob” reuniu algumas técnicas e práticas que, quando aplicadas ao seu código, ajudam a torná-lo mais legível, coeso e consistente. Quer entender melhor como essas boas práticas funcionam? A gente te conta!
Neste artigo você vai encontrar:
Primeiro: o que é e para o que serve o Clean Code?
Uma coisa é certa: um bom software nunca estará completamente finalizado. Com o passar do tempo, ele precisará sofrer alterações e melhorias, seja para incluir, retirar ou simplesmente aperfeiçoar comandos. Pensando nisso, um software que foi criado sem seguir os preceitos do Clean Code se tornará cada vez mais obsoleto.
Isso porque a manutenção e o desenvolvimento também se tornarão complicados. Você, por acaso, já teve aquela sensação de que seria muito mais fácil começar um código novo, totalmente do zero, do que simplesmente dar provisão a um código antigo?
Aposto que sim. Infelizmente, esse tipo de situação é bem comum, principalmente, quando temos um código mal escrito. Mas, nem sempre dá para iniciar um projeto do zero.
Então, a melhor coisa a se fazer aqui é criar código consistente desde o começo. Isto é um código limpo, testável, fácil de ler, compreender, modificar e manusear.
Agora que você já sabe o que é e para o que serve o Clean Code, precisa conhecer também algumas práticas essenciais para deixar o seu código “bem redondinho”.
Confira:
Os códigos também são histórias
Toda história tem um começo, um meio e um fim. Mas, para cativar os leitores, elas também precisam ser contadas de maneira atraente. A mesma coisa acontece com os códigos. Ou seja, para criar um bom código, é preciso, primeiro, estruturá-lo corretamente.
As funções, por exemplo, precisam ser pequenas, claras e executarem apenas uma tarefa por vez. Aliás, de acordo com o Uncle Bob, as funções devem seguir duas premissas:
- A primeira é serem pequenas;
- A segunda é serem ainda menores.
Isso, à longo prazo, irá facilitar a manutenção e a manipulação do código.
Se for preciso, comente. Mas só o que for extremamente necessário!
Uncle Bob é bem categórico na hora de afirmar que os comentários mentem!
Com isso, o nosso guru do Clean Code quer dizer que as linhas de códigos são constantemente modificadas, mas os comentários não. E, por isso, muitas vezes, as pessoas que trabalham com desenvolvimento de software alteram os comandos, mas se esquecem de alterar os comentários. O resultado disso? Estes comentários deixam de retratar as funcionalidades reais daquele código e passam a prejudicar toda a estrutura.
Ou seja, tornam as premissas mentirosas.
Então, não tente salvar um código confuso ou mal elaborado, enchendo ele de comentários. Pelo contrário, prefira fazer comentários pontuais que expliquem o porquê de você estar fazendo algo e não a função que um determinado comando deveria executar.
Não caia na cilada da repetição…
A sigla DRY é um acrônimo para Don’t Repeat Yourself (ou, “não repita a si mesmo”, em tradução livre). Isso significa, basicamente, que não deve haver ambiguidades no seu código. Isto é: duas ou mais partes que irão desempenhar a mesma função.
E porque nós devemos evitar este CTRL C + CTRL V? Simples:
Experimente manter, limpar e cuidar de duas casas ao mesmo tempo. Você verá o quanto isso é complicado, custoso e desgastante. Com os softwares é a mesma coisa, quanto mais funções repetidas você tiver, mais complexo será fazer testes e manutenções.
O caminho se faz ao andar
Lembra da regra do escoteiro que citamos lá no início do texto? Para os programadores, ela seria – mais ou menos – assim: “você deve deixar o seu código mais limpo do que estava antes de alterá-lo”. Refazer um código deve ser um hábito.
Aliás, essa história de “não mexer no que está dando certo” além de ser um mito, também pode virar uma tremenda dor de cabeça no futuro. Um código só está claro, conciso e adequado se você puder aperfeiçoá-lo, testá-lo e validá-lo.
Mas se a gente pudesse te dar um conselho sobre o Clean Code, diríamos que todo este trabalho duro compensa (e muito!). Ao adotar essas práticas, você verá que estará programando mais e melhor, aumentando seu desempenho profissional. E como diria o autor Martin Fowler “qualquer um consegue escrever códigos que um computador entenda. Mas só bons programadores escrevem código que humanos podem entender”.
Aproveite esse clima de desenvolvimento e aperfeiçoamento de habilidades e leia também nosso artigo sobre como aprender uma nova linguagem de programação.
Texto escrito por: PRAVALER
