Sem comentários

Antes de mais nada: o que vou escrever aqui não se aplica a linguagens de ‘baixo nível’, como Assembly, por exemplo. Se você utiliza Java, Delphi, C#, Ruby ou qualquer outra que possa ser chamada de ‘alto nível’, pode continuar lendo.

Comecemos com uma ordem: não comente seu código.

Plaft. O impacto da ordem e os trolls agitam os dedos para começar a criticar.

Para que servem os comentários no código? Ensinaram na escola que é para informar suas intenções aos outros programadores. Teoricamente, quando o próximo coitado abrir o seu código, ele vai entender perfeitamente todas aquelas amarrações e voltas lógicas que você deu no código, apenas se guiando pelos comentários. Genial, não?

Agora, me mostre um só código legado, daqueles sem testes e que passaram na mão de pelo menos vinte estagiários, que tem os comentários perfeitamente atualizados e consistentes com a abordagem utilizada no código. Pois é, esse é o segundo problema que encontramos ao usar comentários. O primeiro, se você ainda não percebeu, é o retrabalho de ter que escrever código e em seguida escrever comentários para explicar o que o código faz.

Claro que ainda não te convenci. Anos de vício não se perdem em uma leitura. “Tudo bem, é só apagar aquele comentário que não faz sentido”. Vou usar um exemplo que encontrei aqui mesmo, no projeto em que trabalho.

O que a linha abaixo quer dizer?

int t = 0;

Nem mais, nem menos. Para mim, está sendo declarada e inicializada uma variável t. Para que serve, eu não faço idéia.

Vamos então comentar o código. Claro, assim o próximo sujeito que der manutenção nesse código vai entender perfeitamente o que estou tentando fazer aqui.

// tentativas de login
int t = 0;

Opa, bem melhor agora, não concorda? É óbvio que t é exatamente a mesma coisa que tentativas de login. Claro. Como não pensei nisso antes? Assim, no meio do código, basta você encontrar a variável, voltar ao local onde ela foi declarada e ler o porquê dela existir. Ou então, você pode ser uma pessoa bem legal e comentar cada linha onde a variável é utilizada. Se você for mais legal ainda, logo você terá um código de 300 linhas, sendo que 160 delas são só comentários. Legal mesmo.

Só que eu não sou um cara legal. Eu tenho preguiça de escrever comentários. Eu acho que um código de 300 linhas com 160 linhas de comentário é uma nojeira difícil de ler. Eu acho uma perda de tempo ter que reescrever comentários para cada linha que eu altero do código. É demorado, pouco produtivo e sujeito a erros. “E então, espertão. Como você faria?”

int tentativasDeLogin = 0;

Que tal assim? Sem comentários, sem nenhuma explicação adicional. Apenas código, puro e simples. O código se torna uma forma clara e concisa de documentação.

Ferramentas como NetBeans, Eclipse e Visual Studio, automatizam o ato de renomear um membro da classe dentro do escopo correto, o que honestamente, me faz desacreditar em qualquer argumento a favor do uso de comentários em detrimento da legibilidade do código.

Por falar em legibilidade, vou começar a inserir linhas entre os parágrafos. Pelo menos para mim isso ajuda muito na hora de ler textos maiores. Espero que te ajude também.

😉

Anúncios

2 respostas para Sem comentários

  1. […] Espero que te ajude também. Tagged: agile, best practices, development. Veja o post completo clicando aqui. Post indexado de: […]

  2. […] Se convenceu agora de que comentários em código, além de dificultarem a leitura e se tornarem um vício, são ruins e devem ser evitados? […]

Deixe um comentário

Preencha os seus dados abaixo ou clique em um ícone para log in:

Logotipo do WordPress.com

Você está comentando utilizando sua conta WordPress.com. Sair / Alterar )

Imagem do Twitter

Você está comentando utilizando sua conta Twitter. Sair / Alterar )

Foto do Facebook

Você está comentando utilizando sua conta Facebook. Sair / Alterar )

Foto do Google+

Você está comentando utilizando sua conta Google+. Sair / Alterar )

Conectando a %s

%d blogueiros gostam disto: