Melhore seu código c# — parte 1 — a regra do escoteiro

Melhore seu código c# — parte 1 — a regra do escoteiro!

Marcio Nizzola
4 min readAug 22, 2024

A Importância da Manutenção de Software: Deixando o Código Melhor do Que Encontramos

Ao atuar no desenvolvimento de software, quanto mais nos aprofundamos em experiência, mais somos colocados à frente de iniciativas de melhoramento de código e aplicações.

Diariamente temos inúmeras tarefas, mas é importante lembrarmos que cada linha de código ficará rodando por muito tempo e é nossa responsabilidade não só escrever código da melhor forma, como refatorar código sempre que encontrarmos algo muito ruim.

Aqui irei falar um pouco sobre alguns pontos onde podemos atuar e melhorar o código que encontramos com o objetivo de criar aplicações que “falem por si mesmas”.

Entendendo o Código Mal Escrito

Quando herdar um código que não segue boas práticas, é comum sentir-se frustrado. No entanto, essa é uma oportunidade valiosa. Ao gastar tempo para entender como o código funciona, podemos identificar áreas que precisam de melhorias. Essa compreensão não apenas facilita a manutenção no curto prazo, mas também ajuda a evitar problemas futuros, tornando a base de código mais saudável.

Vou alterar algo que funciona?

Existe uma velha máxima utilizada muito no Brasil que é “em time que está ganhando não se mexe”, mas será que isso se aplica ao desenvolvimento de software?

Em software podemos ter algo que esteja funcionando, mas mesmo assim podemos:

  • ter um desempenho fraco
  • consumir um volume muito alto de recursos
  • ser de difícil manutenção dada a dificuldade de compreensão

Portanto mesmo funcionando as vezes faz sentido mudar, já que as melhorias justificam os custos !

Como garantir que essa melhoria não vai ser uma “pioria”?

Uma aplicação bem escrita deve ter testes unitários, mas caso não tenha, antes de qualquer mudança é importante implementá-los, e garantir que caso passe a funcionar diferente os testes indiquem a falha evitando que cheguem para uma aplicação em produção !

Para demonstrar as possíveis melhorias, eu levantei alguns pontos interessantes os quais podemos melhorar, irei trazer em cada postagem um ponto diferente, para começar falaremos dos números mágicos.

O Perigo dos Números Mágicos

Um dos problemas mais comuns em código legado que tornam a compreensão do código são os “números mágicos”, mas o que são? já vi muitas coisas por aí, mas é bem comum termos códigos de fornecedores, moedas, códigos de perfis de usuário, códigos de localidade.

Esses valores arbitrários, tornam o código difícil de entender! Podemos com a simples criação de uma tabela de constantes mudar o entendimento do código.

Não é uma boa prática ter identificadores fixados no código fonte, uma vez que tabelas em banco podem mudar, e acarretar em mal funcionamento, mas infelizmente na vida real, muitas vezes temos códigos legados que nos impedem uma melhoria imediata, então que tal apenas melhorar a legibilidade sem implementar mudanças radicais?

Veja exemplo antes:

Longe de ser um código de produção, ou a melhor implementação que já vi, já encontrei algumas coisas similares, mas aqui a idéia é didática, e uma pergunta que fica, é “quem sabe o que é 1, 2, 3, 4” ?

meme: quando escrevi esse código, só eu e Deus entendíamos o que ele fazia. Agora só Deus sabe !

Que tal deixar mais legível ?

Veja exemplo depois da melhoria:

solução para retirada de números mágicos em c# com constantes

Agora ficou muito mais legível e menos trabalhoso para descobrir o que é cada condição !

Podemos utilizar uma classe estática com constantes, ou até um enum

solução para retirada de números mágicos em c# com enum

Gostou do artigo? clique no ícone👏e me siga para ver as próximas publicações !! Quer ver mais conteúdos, acesse minhas redes através do Linktree: https://linktree.com/nizzola

--

--

Marcio Nizzola
Marcio Nizzola

Written by Marcio Nizzola

Microsoft MVP | Software Architect na CI&T | Prof. da Etec Itu | Membro Fundador da Comunidade Itu Developers.

No responses yet