Ao retomar um projeto parado por duas semanas, percebi duas coisas importantes: Primeiro: Duas semanas podem ser uma eternidade na programação; Segundo: comentários são ferramentas poderosas no desenvolvimento de aplicações.
A importância da constância
Um programador, mesmo que trabalhe em uma aplicação pequena ou simples, precisa manter o foco no projeto. Durante o desenvolvimento, surgem soluções para os problemas enfrentados, e novas ideias aparecem naturalmente. Esse foco permite tomar decisões consistentes, resultando em estruturas e funcionalidades harmoniosas ao final do projeto.
Recentemente, revisitei um projeto que abandonei por um tempo porque estava enfrentando dificuldades em alcançar o resultado que planejei. A ideia era criar uma agregadora de informações financeiras. Embora já existam ótimas plataformas, como Status Invest e Investidor 10, eu queria desenvolver a minha própria. O projeto envolvia HTML e CSS básicos, um pouco de JavaScript para integração das informações, lógica matemática para as calculadoras e, ainda não sei como, uma forma gráfica de apresentar os resultados acumulados da carteira.
No entanto, fiquei duas semanas sem tocar no código por causa de um quadro que não conseguia implementar como imaginei. Esse intervalo teve um custo alto: perdi o fio da meada e, por causa disso não lembrava onde havia parado, tampouco conseguia explicar as decisões que havia tomado ou a lógica por trás de algumas partes do código. Em um trecho específico, sequer sabia como ele funcionava (mas funcionava).
Para retomar o projeto, reli todo o código, identifiquei onde cada função atuava e testei se mudanças nos parâmetros mantinham as regras funcionando. O que realmente fez diferença foi adicionar comentários conforme eu esclarecia os pontos do código. Esse processo trouxe vários benefícios.
A importância dos comentários
Comentários bem escritos ajudam a entender o propósito de um código ou funcionalidade específica. Eles facilitam o trabalho de revisitar ou modificar o projeto no futuro. Em equipes, permitem que outros desenvolvedores compreendam rapidamente o que está acontecendo, mesmo sem ter trabalhado diretamente naquela parte do código.
Nem todas as informações de um projeto estarão na documentação oficial, portanto, comentários atuam como uma documentação contextual, próxima ao código. Muitas vezes, decisões técnicas são tomadas por motivos específicos, e explicá-las nos comentários ajuda a preservar esse contexto ao longo do tempo. Além disso, durante a depuração, comentários esclarecem a lógica de trechos complexos, facilitando a identificação de erros.
Boas práticas para comentários
Embora este seja o primeiro projeto em que usei comentários extensivamente, percebi que a clareza e a concisão são fundamentais. Comentários objetivos explicam o que o código faz e por que foi escrito daquela forma, evitando redundâncias ou obviedades.
Seguir um padrão consistente também ajuda quem revisa o código. E, tão importante quanto escrever comentários, é mantê-los atualizados. Sempre que alterar algo no código, revise os comentários relacionados para refletir as mudanças.