Por que utilizar Clean Code mesmo sendo iniciante?

Por ser iniciante, sempre me questionei sobre algumas práticas que via profissionais com um cargo mais alto realizando, me vi, também, muito perdida se era algo que eu deveria estar praticando. A primeira vista o Clean Code pode parecer uma prática para profissionais com mais experiência, porém ele é importante desde o início dos estudos.

Você,estudante de tecnologia, já se perguntou o porquê da importância do Clean Code? Caso você esteja perdido assim como eu no início, nesse artigo iremos falar sobre a importância do Clean Code mesmo sendo iniciante. 

De onde surgiu o Clean Code?

Para explicar um pouco sobre a prática e a importância do Clean Code, iremos começar com fatos históricos. O termo foi primeiro abordado no livro “Clean Code: A Handbook of Agile Software Craftsmanship“, escrito por Robert Cecil Martin e lançado em 2008. Robert também é um dos profissionais por trás do Manifesto Ágil, lançado em 2001. 

Notou-se que a proporção média de leitura e escrita de códigos fonte é de 10 para 1. Isso significa que os programadores dedicam significativamente mais tempo tentando compreender e interpretar o código existente do que efetivamente escrevendo novas linhas de código. Essa desproporção entre a leitura e a escrita de código é um fenômeno notável no mundo da programação. Por que isso acontece? À medida que os projetos crescem em escopo e se tornam mais intrincados, o código existente se expande e se ramifica, tornando-se cada vez mais desafiador de entender. Consequentemente, os programadores se veem envolvidos em uma tarefa que pode ser igualmente gratificante e frustrante: decifrar o código legado.

Essa realidade coloca em evidência a importância do "Clean Code". Quando o código é escrito de forma organizada, seguindo boas práticas de programação e mantendo-se legível, a tarefa de compreensão torna-se consideravelmente mais ágil e menos propensa a erros. Além disso, a colaboração entre desenvolvedores é facilitada, uma vez que o código é mais acessível e transparente.

Michael Feathers, autor de "Working Effectively with Legacy Code", coloca a palavra “cuidado” como central para um código limpo. Acredito que a maioria dos programadores sabe a importância de escrever um código bem e cuidar dele! Com o Clean Code isso é possível, pois a prática leva a um código mais limpo, como o próprio nome diz, e te obriga a cuidar melhor do seu código para futuras manutenções.  

O Clean Code, inspirado por esses pioneiros, não é apenas uma questão de estética; ele é uma resposta a um problema crítico que afeta todos os desenvolvedores: a complexidade inerente ao desenvolvimento de software. À medida que os projetos crescem em escopo e as equipes se expandem, a necessidade de código limpo se torna ainda mais crucial. Mas por quê o Clean Code é tão importante?

Por que o Clean Code é importante?

Durante leituras e estudos sobre o assunto, conseguimos perceber que a prática está ligada a uma facilitação da leitura e da escrita de um código. Mas vamos ver isso na prática? Abaixo está uma imagem sobre como o código limpo facilita a sua leitura e entendimento do mesmo

Na esquerda temos um código, que não tem uma formatação padrão e na direita já temos a formatação mais “clean”. Porém o tópico de formatação é apenas um dos motivos para o clean code funcionar. Vamos ver mais um exemplo?

O Clean Code não é só para uso e manutenção pessoal do código, mas por exemplo, quando uma empresa desenvolve um software para suas operações, ela inevitavelmente enfrentará mudanças. As demandas do negócio evoluem, as necessidades dos usuários se modificam e, com o tempo, o código originalmente criado terá que ser atualizado e aprimorado para acompanhar essas transformações.

O código limpo não é apenas uma questão de estética, mas está intrinsecamente ligado à qualidade e eficiência do software. Códigos bem organizados, de fácil leitura e manutenção não apenas aceleram o processo de desenvolvimento, mas também reduzem erros e facilitam a identificação e correção de problemas. Além disso, o Clean Code promove a colaboração eficaz entre equipes de desenvolvimento, tornando a manutenção do software mais simples e econômica a longo prazo. O Clean Code não é apenas uma preferência, mas uma necessidade para criar software confiável, sustentável e de alto desempenho.

O que um código limpo precisa?

Para compreender verdadeiramente a importância de um código limpo, é essencial analisar o que exatamente caracteriza essa qualidade. "O que um código limpo precisa?" É uma pergunta fundamental para os desenvolvedores que buscam pela clareza, eficiência e facilidade de manutenção em seus programas. Neste tópico, exploraremos as principais características e critérios que definem um código como limpo, destacando os princípios que contribuem para o desenvolvimento de software de qualidade.

• Simples e direto: seguindo o princípio de KISS (Keep It Simple Stupid), o código bem escrito deve ter o mínimo de complexidade possível, para que possa ser facilmente depurado e compreendido.
• Seco: o código DRY “Don’t Repeat It” – conceito trazido por Andy Hunt, um dos autores do Manifesto Ágil -, é aquele sem ambiguidade, ou seja, se você já o inseriu em algum lugar no código-fonte, ele não deve ser implementado novamente.
• Eficiente: um código é programado para atender a algum objetivo específico, então procure se certificar que ele funcionará da forma que foi proposto.
• Elegante: Bjarne Stroustrup, inventor do C++, diz que gosta dos seus códigos elegantes e que, quando você o lê, deve se sentir feliz. A ideia da elegância é tornar o código diferente dos demais.
• Atenção aos detalhes: o programador deve sempre criar um código de forma cuidadosa, já que um código mal escrito desde o início impactará em sua manutenção, trazendo grandes prejuízos e lentidão para entendê-lo.
• Atenção aos comentários: comente o mínimo possível em seu código. O código já deve ser claro o suficiente para não necessitar de comentários. Caso necessite, tente comentar o mínimo possível. 

(SYDLE 18/03/2022)

Em resumo, um código bem escrito é simples, eficiente, elegante, sem repetições desnecessárias, cuidadosamente desenvolvido e com comentários mínimos. Isso facilita a manutenção e compreensão a longo prazo.

Regras do Clean Code

Ao embarcar na prática de escrever código limpo, é fundamental compreender não apenas os princípios subjacentes, mas também as regras específicas que o guiam. Robert C. Martin, também conhecido como "Uncle Bob", definiu essas regras essenciais no seu livro "Clean Code". Essas regras estabelecem diretrizes precisas para a criação de software de qualidade, abordando aspectos que vão desde a nomenclatura de variáveis até a estruturação de funções e classes. Exploraremos essas regras do Clean Code, que servem como um roteiro fundamental para os desenvolvedores em busca da excelência na escrita de código.

• Nomes Descritivos: Escolha nomes de variáveis, funções e classes que sejam descritivos e revelem a intenção por trás do código.
• Funções Pequenas: Mantenha as funções curtas e focadas em fazer uma única coisa. Idealmente, uma função deve ter apenas uma razão para existir.
• Comentários Significativos: Use comentários para explicar o "porquê" do código, não o "o que". Os comentários devem esclarecer a intenção e os motivos por trás das decisões de design.
• Evitar Comentários em Excesso: O código deve ser autoexplicativo. Evite comentários em excesso, pois eles podem se tornar desatualizados e confundir.
• Evitar Código Repetitivo: Evite duplicação de código. Em vez disso, crie funções ou classes para reutilização.
• Limitação de Parâmetros de Função: Evite funções com muitos parâmetros. Idealmente, uma função deve ter zero, um ou, no máximo, dois parâmetros.
• Manter Linhas Curtas: Limite o comprimento das linhas de código para facilitar a leitura e a compreensão (geralmente entre 80-120 caracteres por linha).
• Indentação Consistente: Siga um estilo de formatação consistente para manter o código bem organizado.
• Classe com Responsabilidade Única (SRP): As classes devem ter apenas uma razão para mudar. Elas devem ter uma única responsabilidade claramente definida.
• Princípio Aberto/Fechado (OCP): O código deve estar aberto para extensão, mas fechado para modificação. Isso é alcançado por meio do uso de abstrações e interfaces.
• Princípio de Substituição de Liskov (LSP): Classes derivadas devem ser substituíveis por suas classes base sem afetar o comportamento do programa.
• Princípio de Segregação de Interface (ISP): Clientes não devem ser forçados a depender de interfaces que não utilizam. Isso leva à criação de interfaces específicas para clientes.
• Princípio de Inversão de Dependência (DIP): Dependa de abstrações, não de implementações concretas.

Lembrando que a aplicação dessas diretrizes pode variar dependendo da linguagem de programação e do contexto do projeto, mas, em geral, elas ajudam a melhorar a qualidade do código, tornando-o mais compreensível e fácil de manter.

Programadores iniciantes

Para entrar na área de programação, precisa de estudo e muita dedicação, como em qualquer área! Com a ajuda de recursos online, tutoriais e a orientação de programadores mais experientes, o iniciante constrói as bases para se tornar um desenvolvedor competente. E existem algumas dicas que acabam sempre sendo passadas similarmente. Como entender um código te faz um bom desenvolvedor, aprender lógica de programação é o primeiro passo, aprender a ler erros, entre outras dicas.

Porém ao longo do artigo, te apresentei o Clean Code e como utilizar a prática no seu dia a dia com programação. E como isso se aplica à iniciantes? 

Por que aplicar o Clean Code mesmo sendo iniciante?

Desenvolvedores iniciantes são telas em branco, todo conhecimento passado vai sendo absorvido e replicado. Quando já se inicia na área tendo noção do Clean Code, o processo se torna mais confortável e prático. 

Um código limpo e bem organizado é muito mais fácil de entender. Isso é fundamental para programadores iniciantes, pois ajuda a acelerar o processo de aprendizado, permitindo que eles compreendam melhor os conceitos e técnicas de programação.

Além da facilidade de entendimento do código, programadores iniciantes tendem a cometer erros. Um código limpo torna a identificação e correção de erros mais direta, economizando tempo e frustração.

Estratégias para implementar o Clean Code na prática sendo iniciante

Quando se é um programador iniciante, a busca pela prática do Clean Code pode parecer uma tarefa desafiadora. No entanto, existem estratégias específicas que podem facilitar essa jornada rumo a um código mais limpo e legível. Uma abordagem inicial eficaz é começar com a escolha da linguagem de programação adequada. Algumas linguagens, como Python, possuem uma sintaxe naturalmente mais limpa, tornando-as uma escolha sólida para iniciantes que buscam aderir ao Clean Code desde o início.

Além disso, o uso de ferramentas de análise de código e IDEs (Ambiente de Desenvolvimento Integrado) específicas pode ser extremamente útil. Essas ferramentas são capazes de destacar áreas problemáticas no código, alertando os desenvolvedores sobre possíveis violações das diretrizes do Clean Code, como nomes de variáveis pouco descritivos ou funções excessivamente longas. À medida que o desenvolvedor adquire experiência, essas sugestões se tornam oportunidades de aprendizado valiosas.

Por fim, um dos passos mais essenciais é a prática contínua. Resolver desafios de programação, contribuir para projetos de código aberto e analisar o código de programadores mais experientes são maneiras eficazes de aprender a escrever código limpo na prática. Com o tempo e a dedicação, um programador iniciante pode se tornar proficiente em criar código limpo e eficiente.

Conclusão

Portanto, é evidente que o conceito de "Clean Code" desempenha um papel essencial na evolução dos programadores novatos no campo da programação. A utilização de código limpo simplifica a compreensão e a colaboração, ao mesmo tempo que estabelece boas práticas desde o início. Esse código atua como uma referência sólida que diminui a complexidade, aumenta a confiabilidade e capacita programadores iniciantes para enfrentar desafios mais complexos no futuro.

À medida que os programadores se aprofundam nesse conceito e adotam princípios de código limpo em seu trabalho cotidiano, eles desenvolvem uma base sólida para aprimorar suas habilidades técnicas e se tornar profissionais mais competentes na área da programação. O "Clean Code" serve como um pilar de orientação para o desenvolvimento de competências essenciais para progredir na carreira. Em última análise, seu valor reside em seu potencial para tornar programadores iniciantes mais proficientes e confiantes em seu ofício, capacitando-os a abordar desafios avançados com maior compreensão.

Ao escrever código limpo desde o início, os programadores iniciantes não apenas constroem uma estrutura sólida para suas habilidades, mas também contribuem para um ambiente de programação mais eficiente e colaborativo. Com o tempo, esses novos desenvolvedores se tornam experientes que estão prontos para enfrentar projetos complexos e manter sistemas com facilidade. Portanto, a ênfase no Clean Code é uma estratégia valiosa que não apenas beneficia os iniciantes, mas também a comunidade de desenvolvimento de software como um todo.

Espero que com esse artigo, além de aprender um pouco sobre o Clean Code, te instigue a buscar formas de aplicar no seu código e dia a dia dentro da programação. E isso vale especialmente para iniciantes, pois a prática do código limpo te auxilia a compreender melhor a programação no todo. 

Referências

Descubra o conceito de Clean Code e seus princípios. Disponível em: https://www.valuehost.com.br/blog/clean-code/

Clean code: quais são as boas práticas de programação? Disponível em: https://www.sydle.com/br/blog/clean-code-602bef23da4d09680935509b

Conheça os 7 princípios do Clean Code. Disponível em: https://www.hostgator.com.br/blog/clean-code-o-que-e/

Clean code: o que é, porque usar e principais regras! Disponível em: https://blog.betrybe.com/tecnologia/clean-code/#5

Clean Code na Prática. Disponível em: https://pt.slideshare.net/DouglasSiviotti/clean-code-na-prtica

Dicas para programadores iniciantes. Disponível em: https://www.treinaweb.com.br/blog/dicas-para-programadores-iniciantes