Article image
Gabriel Oliveira
Gabriel Oliveira24/10/2023 17:17
Compartilhe

A Importância da Cultura de Clean Code para Iniciantes na Programação

  • #Arquitetura de Sistemas

Imagine o cenário onde você está aprendendo a cozinhar pela primeira vez. Seguiremos uma receita para facilitar isso, mas a página está cheia de manchas, rabiscos e anotações ilegíveis. Será difícil preparar uma refeição deliciosa com essas instruções confusas. No desenvolvimento de software, a cultura de aplicar Clean Code tem sua enorme importância assim como é importante uma receita bem estruturada e de fácil entendimento

Neste artigo aprenderemos:

  • Clean Code: A Base do Desenvolvimento de Software
  • Por que a Cultura de Clean Code é Importante para Iniciantes
  • Os Princípios de Robert C. Martin sobre Clean Code
  • Importância das Boas Práticas de Formatação de Código

Clean Code: A Base do Desenvolvimento de Software

Clean Code é uma forma de escrita de códigos fundamental para manter a Alta qualidade. Promove a criação de um código organizado, legível e fácil de manter. Para iniciantes na programação, abraçar a cultura de Clean Code é essencial, assim como para um chef aspirante é nescessario uma receita bem escrita e estruturada.

A Analogia da Cozinha

Agora imagine que você está em uma cozinha pela primeira vez. Você possui uma gama de ingredientes à sua disposição, mas não um ponto por onde iniciar. A cultura de Clean Code funciona como uma receita bem escrita. Ela fornece as instruções necessárias para criar um prato delicioso, ou seja, um software funcional e eficiente.

image

Por que a Cultura de Clean Code é Importante para Iniciantes

1. Compreensão e Aprendizado

Assim como uma receita clara ajuda um cozinheiro iniciante a entender o processo de culinária, o Clean Code ajuda um programador iniciante a entender os conceitos de programação. Nomes significativos para variáveis, funções bem definidas e formatação consistente tornam o código mais acessível.

2. Redução de Erros

Uma receita organizada evita que você misture ingredientes de maneira inadequada. Da mesma forma, o Clean Code ajuda a evitar erros de programação. Funções pequenas e bem definidas, com nomes descritivos, tornam o código menos propenso a bugs.

3. Colaboração Eficiente

Em uma cozinha, várias pessoas podem trabalhar juntas se seguirem a mesma receita. No desenvolvimento de software, a cultura de Clean Code permite que diferentes programadores colaborem com eficiência, pois podem entender e modificar o código uns dos outros com facilidade.

4. Manutenção Simplificada

Um cozinheiro sabe que precisa limpar a cozinha após a refeição. Da mesma forma, a manutenção de código sujo é uma tarefa árdua. O Clean Code facilita a manutenção, pois torna mais fácil adicionar novos recursos e corrigir bugs.

5. Crescimento Profissional

Assim como um cozinheiro pode aprimorar suas habilidades ao seguir receitas cada vez mais complexas, os programadores iniciantes podem melhorar suas habilidades ao praticar o Clean Code. Isso ajuda a construir uma base sólida para o crescimento profissional.

Os Princípios de Robert C. Martin sobre Clean Code

Robert C. Martin, foi uma figura proeminente no desenvolvimento de software, ele estabeleceu certos princípios valiosos para o Clean Code."Uncle Bob" como era conhecido, acredita em várias práticas e princípios relacionados à engenharia de software, como Clean Code, SOLID Design, Test-Driven Development (TDD). Aqui estão alguns de seus princípios essenciais:

1. Nomes Significativos

Escolha nomes significativos para variáveis, funções e classes. Nomes bem escolhidos tornam o código mais legível e compreensível.

image

💡 Padrões de Nomes de Variáveis (Naming Conventions)

Convenções de nomenclatura que definem como as variáveis devem ser nomeadas em um programa. Seguir padrões de nomenclatura ajuda a tornar o código mais consistente e legível. Alguns exemplos comuns incluem o uso de camelCase (nela a primeira letra é Minúscula, e toda vez que vai iniciar uma nova letra colocamos a primeira letra Maiúscula) para nomes de variáveis em JavaScript ou Java, ou snake_case(neste separamos as palavras por underline) em Python.

2. Funções Pequenas

Mantenha as funções pequenas e focadas em fazer uma única coisa. Funções pequenas são mais fáceis de entender e reutilizar.

image

3. Comentários Significativos

Use comentários para explicar o porquê de algo, não o que está fazendo. Seu código deve ser autoexplicativo, mas os comentários podem fornecer contexto.

image

4. Formato Consistente

Siga um estilo de formatação consistente em todo o código. Isso inclui a indentação, uso de espaços em branco e convenções de nomenclatura.

image

5. Testes Unitários

Escreva testes unitários para cada parte do código. Isso ajuda a identificar problemas mais cedo e garante que as alterações futuras não quebrem funcionalidades existentes.

image

💡 Frameworks de Testes

Fornecem ferramentas e estruturas para facilitar a criação e execução de testes.

Esses exemplos demonstram como aplicar os princípios de nomes significativos, funções pequenas, comentários significativos, formato consistente e testes unitários em JavaScript para tornar o código mais legível, compreensível e confiável.

Esses princípios de Robert C. Martin não apenas tornam o código mais limpo, mas também facilitam a manutenção, colaboração e expansão do software ao longo do tempo.

A Importância das Boas Práticas de Formatação de Código

A formatação de código é a chave para criação de código limpo e legível. Para iniciantes na programação é essencial compreensão das boas práticas na hora de formatar. Estas práticas incluem a consistência na indentação, o uso adequado de espaços em branco, a organização de elementos do código e a adoção de convenções de nomenclatura. Com isso boas práticas não apenas torna o código mais esteticamente agradável, mas também facilita a colaboração e a manutenção do software.

Nos exemplos abaixo podemos ver os impactos da aplicação das Boas Práticas em HTML e m JavaScript:

Exemplo 1: JavaScript

Código sem Boas Práticas:

image

O código é difícil de ler devido à falta de espaçamento e formatação inadequada. Os nomes de variáveis e funções são menos descritivos, tornando o código menos claro. Impossibilitando que as outras pessoas possam compreender o código, e dificulta futuras atualizações.

Código com Boas Práticas:

image

O código é legível e bem formatado. Há espaçamento adequado, identação consistente e nomes significativos de variáveis e funções. Isso torna o código fácil de entender e manter. O que proporciona muitas vantagens como o fácil compartilhamento de informações pois utilizam formatações universalmente adotadas.

Exemplo 2: HTML

Código sem Boas Práticas:

image

O código acima está em uma única linha, o que o torna difícil de ler e editar. A falta de identação e formatação adequada prejudica a clareza do código HTML. Além disso não o torna prático como da para perceber na imagem quando ela não consegue enquadrar todo o código.

Código com Boas Práticas:

image

O código HTML aplicado às Boa Práticas está bem formatado, com uma estrutura clara, espaçamento adequado e tags HTML identadas. Isso torna o código mais legível e facilita a manutenção. Mantendo uma estrutura prática.

💡 Refatoração de Código (Code Refactoring)

A refatoração é onde você altera seu código com o intuito de buscar melhorias e mais praticidade sem alterar seu objetivo final. A refatoração é uma prática importante para manter a qualidade do código ao longo do tempo.

E como muitas vezes frisado, a adoção de todas estas práticas até aqui é com intuito de tornar o código sempre de fácil leitura e facilitar na manutenção do mesmo.

Conclusão

A programação é uma disciplina em constante evolução, e aqueles que a praticam, sejam eles programadores iniciantes ou programadores seniores, enfrentam desafios complexos na busca por soluções de alta qualidade. Quando se inicia na programação, muito se subestima as boas práticas na escrita e na formatação, mas como diz Robert C Martin "Código limpo sempre parece ter sido escrito por alguém que se importa."

Não é exagerado argumentar que a Prática do Clean Code é um dos pilares da Programação e com o tempo tais práticas como as citadas neste artigo mostram sua verdadeira importância, seja com simples comentários á testes de validação, manter seu código com um Layout de fácil interpretação, sempre aberto a melhorias e respeitado convenções universalmente propostas faram diferença na hora de colocar suas ideias e planos pratica e compartilhar seus conhecimentos com a comunidade.

Este compromisso não termina com a aquisição de experiência, mas um aprendizado continuo, uma filosofia de orientação a criação de softwares de qualidade. Steve Jobs falava que você tem que amar o que faz, e uma boa demonstração disso é fazer algo limpo e organizado focado em um entendimento universal.

Bibliografia

Do Carmo, Anderson. "Resenha do Livro Clean Code." Medium, 14 de Fevereiro de 2020, Disponível em: https://medium.com/realizeit/resenha-do-livro-clean-code-76d61b6e6ed6.

MARTIN, Robert C. Clean Code: A Handbook of Agile Software Craftsmanship. [S.l.]: Prentice Hall, 2008.

UNICAMP. Boas Práticas de Programação. Disponível em: https://liag.ft.unicamp.br/programacao2/boas-praticas-de-programacao/. Acesso em: [24/10/2023].

DIO.ME. Dio.me. Disponível em: https://web.dio.me/home. Acesso em: [24/10/2023].

Compartilhe
Comentários (1)

FB

Fernanda Braz - 24/10/2023 19:26

Muito interessante este artigo autoexplicativo.