Clean Code — É inútil comentar

Existem pessoas que acreditam que todo código deveria ser comentado, entenda porque esta é uma ideia errada.

Um dos maiores motivos para escrever comentários é código ruim, um código tão confuso que sem eles seria impossível entender por exemplo o que é aquela variável a,bou c. Então o programador(a) entende que deveria escrever comentários no código, explicando como as coisas funcionam.

Se você é assim, fique atento pois, você está fazendo tudo errado, mas calma que te explico como melhorar.

Sempre que um você comenta um código

• Você é tomado pelo “desânimo” que não te deixa melhorar os códigos;
• Você fracassa como desenvolvedor(a) pois não conseguiu se expressar como deveria apenas através dos códigos;
• Você tenta explicar o inexplicável;

Mas antes que você comece a se culpar por aquele comentário que acabou de escrever, preciso dizer que existem casos onde comentários são suportáveis e até necessários, primeiro entenda o que é um comentário de código e observe abaixo um exemplo de código ruim, onde existe um comentário afim de solucionar a confusão.

O que é um comentário de código

• É a tentativa de expressar um intuito;
• É um mal “necessário”, algumas vezes;
• Não é motivo de comemoração.

Comentários “suportáveis” deveriam

• Fornecer informações sobre direitos autorais;
• Revelar uma intenção obscura;
• Clarificar uma ideia muito complexa;
• Avisar sobre efeitos colaterais em código legado;
• TODO, os famigerados “depois eu faço”;
• PHPDOC, Javadocs, etc…

Abaixo vemos o mesmo exemplo de código que criamos antes, agora reescrito e sem comentários, a intenção do trecho fica clara apenas com a criação de um método que verifica as informações do funcionário.

Conclusão

Da próxima vez que você pensar em escrever um comentário em um código pense se realmente é necessário, e na dúvida não comente, refatore.