Clean Code
A Arte de Escrever Comentários que Não Explicam Nada
25 de Janeiro, 20244 min de leitura
O Clássico "O Que"
i++; // incrementa i
Obrigado, Capitão Óbvio. Se eu não soubesse o que `++` faz, eu não deveria estar aqui. O comentário inútil ocupa espaço, gasta bytes e insulta a inteligência do leitor.
O Comentário Mentiroso
// Retorna true se o usuário for admin
return false;
O código mudou. O comentário não. Agora você tem um comentário que mente descaradamente e te induz ao erro. Confie no código, nunca no comentário.
O Pedido de Desculpas
// Deus me perdoe por isso, mas o prazo acaba hoje
eval(input);
Esse comentário é um grito de socorro. Ele não explica o código, ele confessa um crime. Se você encontrar isso, fuja.
O TODO Eterno
// TODO: Refatorar isso urgente
(Data do commit: 4 anos atrás)
"Urgente" é um conceito relativo no desenvolvimento de software. Esse TODO é agora parte da arquitetura do sistema. É um monumento histórico.
A Biografia
// Criado por João em 2015. Modificado por Maria em 2016. Quebrado por Pedro em 2018.
Git blame existe pra isso, gente. Não precisamos de uma árvore genealógica no cabeçalho do arquivo.