Pular para o conteúdo
Even3

Comentários no código como sinal de alerta

Trecho de 1 min 11 s de Refactoring, gravado no evento VI Semana de Ensino, Pesquisa e Extensão - SEPE.

Assistir à gravação completaNo Even3 Conteúdos · 1 h 12 min

Sobre este trecho

Entenda por que a necessidade de explicar o código através de comentários pode indicar problemas de clareza e legibilidade.

Vai de a da gravação.

O que é dito neste trecho

E um outro code smell que que pode ser considerado aqui são os comentários. É muito comum as pessoas dizerem que comentários eh, ah, eu vou colocar esse comentário aqui para explicar o que eu fiz. Se você precisa explicar o que você fez, é sinal que o teu código não está tão legal porque um código bem escrito, um código limpo, ele não precisa de explicação. Então a gente tem que utilizar o nome de variável, o nome de função justamente para explicar o que o nosso código faz. Se a minha função ela vai no meu banco de dados e busca um usuário, o nome da função tem que dizer o que ela faz e não um comentário em cima da função que que vai explicar para o programador o que que ela faz. A gente tem que entender que a pessoa que vai pegar aquilo ali ela entende lógica de programação e ela sabe ler. Então a partir do momento que ela vê que o nome da função é busca usuário, eu não preciso de um comentário ali dizendo que vai retornar um usuário, é um pouco óbvio. Então sempre que você for colocar um comentário no teu código, pensa se você não pode melhorar isso, ao invés de eu colocar um comentário, o que que eu posso fazer para o meu código ficar tão limpo a ponto de eu não precisar colocar o comentário, que a pessoa olha o meu código e consiga entender o que ele faz sem precisar de nenhum comentário adicional.

Outros trechos deste conteúdo