Escolher um nome de uma função ou de uma variável pode influenciar diretamente na interpretação do seu código. Use nomes que revelam o propósito do que aquela parte do código quer fazer. Como podemos aplicar isso no mundo real?
Imagine uma variável chamada “theList” com uma lista ou array dentro.Tente imaginar o que tem dentro de theList. Uma lista de que? de numeros? Não dá para saber.
Agora olhe o código e identifique o que tem dentro de “theList”:
Fácil de identificar o que tem dentro né? Agora imagine que você não viu o que tem em “theList” e olhe o próximo código:
E agora? Como você ia saber o que é theList? Você teria que ir no arquivo e ver o que theList faz, isso vai custar tempo. Seria muito mais fácil se theList se chamasse:
- “listPeoples”
- “dataPeoples”
Agora sim, sabemos o que tem dentro da antiga “theList”.
Agora vamos às funções:
Onde está o erro dessa função? Além de fazer mais de uma coisa, ela está com um nome que fala que ela soma, mas ela soma e multiplica. Agora imaginemos o seguinte cenário:
Você está num código com muitas linhas e muitas funções com mais de uma funcionalidade e foi gerado um erro dentro daquela linha que multiplica os valores por que algum companheiro da produção colocou uma string no lugar de number. Imagina quanto tempo você iria perder procurando de onde vem esse bug?
Agora vamos ver um formato que diminuiria esse tempo além de deixar o código mais bonito e com uma aparência clean:
Entenderam a diferença? Agora sim ficaria mais fácil de entender e controlar o que está acontecendo.
Gostou do post? Você pode compartilhar com amigos e criar uma rede de conhecimento!
Esse post faz parte de uma série que estamos fazendo falando sobre os princípios do Clean Code:
(Clean Code #1) Funções e variáveis: Como os seus nomes podem influenciar na leitura do seu código.
(Clean Code #2) Como comentar corretamente seu código?
(Clean Code #3) Funções, classes, métodos e variáveis: como nomear corretamente?
(Clean Code #4) Como saber se seu método ou função foi escrito “corretamente”?
Recomendo os seguintes links para se aprofundar ainda mais nas dicas do livro Clean Code:
Resumo do Clean Code (Freecodecamp em inglês)
Github com todos os conceitos do Clean Code aplicado ao Javascript (Em Português!)
Se quiser, você pode também comprar o livro na Amazon.