fundo
(Clean Code #2) Como comentar corretamente seu código?

Você deve evitar comentários desnecessários. Um bom código fala por si, sem precisar de que as coisas sejam explicadas. Uma frase conhecida do Martin Fowler que pode ser usada nesse exemplo: 

"Qualquer idiota pode escrever um código que um computador pode entender. Bons programadores escrevem código que os humanos podem entender."

Para entender melhor o que estou falando veja essa imagem a seguir:

E perceba que essa variável já tem um nome que diz o que ela faz. Não precisa desse comentário explicando. O nome da variável é auto explicativo, inclusive falamos disso no post anterior

Agora vamos para um exemplo diferente, veja na imagem:

E perceba como essa função não precisa desse comentário! Ela já fala por si. Se seu código precisa de comentários para que as pessoas precisem entender, ele precisa ser reescrito. 

Gostou desse conteúdo? Compartilhe esse conteúdo nas redes sociais e vamos criar uma  corrente 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.

Deixe um comentário

O seu endereço de email não será publicado. Campos obrigatórios marcados com *