Hoje vamos nos aprofundar em código limpo no delphi e dar algumas orientações de como utilizá-lo. Limpe seu código agora!
Todos nós, desenvolvedores, temos o desejo de ver nosso código funcionando na melhor estrutura possível, certo? Quando digo “ trabalhando” não me refiro apenas à execução correta, mas também à qualidade do código e ao nível de expressividade que ele revela. Afinal, quando codificamos uma solução, o resultado será visto por nossos usuários E por nós mesmos .
Acredito que você já tenha se deparado com um código antigo e gastou vários minutos (ou talvez algumas horas) tentando entender o que ele faz. Da mesma forma, também acredito que você reescreveu blocos de código devido à falta de clareza. Estou certo?
O conceito de Clean Code foi elaborado justamente para evitar a ilegibilidade do código e melhorar a qualidade técnica de nossa implementação. O Clean Code fornece um conjunto de instruções que devem ser adotadas por qualquer desenvolvedor que queira ser reconhecido como um bom profissional. No entanto, ao contrário do que muitos pensam, apenas a leitura do livro não é suficiente para tomar conhecimento de todas as diretrizes do Código Limpo. O desenvolvedor precisa de tempo, prática e, acima de tudo, perseverança para produzir um código inteligível. Para tanto, resolvi reunir alguns pontos abordados no livro e compartilhá-los neste artigo a fim de disseminar os fundamentos deste conceito. Leia-os cuidadosamente e lembre-se deles quando escrever seu próximo código.
1) É improvável escrever um código limpo ao iniciar uma nova implementação
Mesmo se você tentar, é praticamente impossível. Embora seja extremamente importante que um desenvolvedor comece uma implementação tendo em mente as diretrizes do Código Limpo, ele eventualmente retornará ao código para refatorar ou renomear alguns métodos e variáveis ??passíveis de má interpretação. No entanto, isso é perfeitamente natural. Quando iniciamos uma nova implementação, não sabemos exatamente quantos métodos serão necessários. Não sabemos como nomeá-los e declará-los também. Então, não há nada para limpar. É só quando o código toma forma que começamos a encontrar os “pontos sujos”.
2) Pare de codificar quando perceber que o código está ruim
Evite escrever todo o código e só limpe depois. A limpeza deve ser feita gradativamente, caso contrário, é bem provável que o desenvolvedor perca o contexto do código como um todo. Aquela velha ideia de “vou deixar assim por enquanto e depois volto para consertar” é um bilhete grátis para o esquecimento. Portanto, ao perceber que o código está tomando proporções inadequadas e expondo sinais de duplicidade, pare de escrever e faça uma limpeza antes de prosseguir. É a mesma situação de um bloco de cimento que acabou de ser colocado de forma errada no chão: aproveite para consertar enquanto ainda está úmido, pois, se secar, o trabalho de recolocá-lo ou reformar será sem dúvida mais difícil.
3) Aprenda a programar com paciência
Um dos efeitos da prática do Clean Code é a atividade constante de remover e adicionar o mesmo código repetidamente. Faz parte do processo de maturidade atingir o nível ideal de qualidade. Nem me lembro quantas vezes tive que criar, modificar, remover, criar novamente e renomear uma classe. Em cada etapa, criei uma perspectiva diferente do código e a modifiquei para torná-la mais compreensível.
Como analogia, considere que você acabou de se mudar para uma nova casa e está organizando os móveis da sala principal para encontrar a acomodação mais confortável. Provavelmente você vai precisar mudar várias vezes a localização dos móveis, certo? Essa é a questão! Assim como você busca a melhor disposição dos seus móveis, você também deve buscar a melhor estrutura do seu código. Ainda sobre a analogia, mais uma semelhança: da mesma forma que as pessoas vão visitar a sua casa, outros desenvolvedores também irão “fazer uma visita” ao seu código!
O que quero dizer é que, se você deseja criar um código limpo e valioso, esteja pronto para desfazer e refazer blocos de código quantas vezes forem necessárias.
4) Considere a programação como uma atividade de alto risco
Se um requisito funcional não estiver documentado, é relativamente simples corrigir a documentação. Se houver um erro na estimativa, o cronograma e as histórias do usuário podem ser ajustados com o PO. No entanto, se um código for mal escrito, reescrevê-lo é algo lento e, na maioria das vezes, caro. Além disso, você não poderá garantir que terá o mesmo comportamento de antes, a menos que execute testes de unidade eficazes.
Devemos ter um compromisso com a relevância do nosso código, considerando que o resultado da implementação (e, consequentemente, a funcionalidade) está intimamente relacionado ao nosso nível de responsabilidade. E, ei, queremos ser responsáveis!
Para deixar claro, o objetivo deste tópico não é pressionar a consciência do desenvolvedor ou puni-lo por escrever um código imperfeito, mas sugerir que ele considere a importância de sua atividade quando se trata da qualidade do projeto, arquitetura sustentável, colaboração e, claro, o ciclo de vida do projeto.
5) Melhore sua sensibilidade ao código
Ao utilizar práticas de Clean Code, o desenvolvedor constrói e desenvolve uma habilidade chamada “sensibilidade ao código” . Este termo refere-se à capacidade de ler um código ruim e pensar imediatamente em diferentes maneiras de limpá-lo. Renomear variáveis, reescrever códigos aninhados, refinar condições, extrair métodos e até buscar melhores alternativas para lidar com a lógica de negócios são exemplos de grande sensibilidade técnica. Quanto maior esse nível de sensibilidade, melhores serão as soluções desenhadas e escritas pelo desenvolvedor. Princípios SOLID e Design Patterns estão incluídos aqui!
6) Escreva seu código pensando na legibilidade
Uma boa recomendação de como praticar Clean Code é escrever o código já pensando que alguém vai ler no dia seguinte. Na verdade, isso provavelmente acontecerá. Portanto, certifique-se de ler cada método logo após escrevê-lo e tente medir o nível de legibilidade. Tente se colocar no lugar de outros desenvolvedores e encontre as dificuldades que eles podem ter ao ler seu código. Embora pareça uma tarefa cansativa, na verdade é gratificante, pois você conhece a qualidade do seu próprio código para fazer algo melhor na próxima vez.
Bem, espero ter transmitido o básico da prática do Código Limpo. É tudo por agora!
Eu gostaria de agradecer a todos por visitarem meu blog e também por terem tirado um tempinho para ler este artigo.
Sempre que possível, postarei mais artigos em inglês, ok?
Tchau!