Depois de vermos no post sobre código fonte sem comentários o quão ruim é esta prática, é hora de conhecermos outro cenário quase tão desagrádavel quanto: comentários em excesso.

A Transição

A maioria dos aspirantes a desenvolvedor já sabe da existência dos comentários quando está aprendendo a sua primeira linguagem de programação. Mas, como disse no post anterior, nesse momento nós ainda não temos maturidade para entender os benefícios desta abordagem, e consequentemente não comentamos nada.

Passado esse estágio inicial, e em geral quando já estamos na segunda linguagem, é comum lermos novamente sobre os comentários e a sua importância. Como neste momento nós já possuímos um pouco mais de conhecimento, e em geral também passamos a nos preocupar com as boas práticas no desenvolvimento de software, tendemos a reconhecer o valor dos comentários e os adotamos.

No meu caso, essa mudança de hábito ocorreu quando começei a estudar Java, aproximadamente 6 meses depois de aprender o básico sobre programação com o Pascal. Eu estava estudando através do clássico livro Java - Como Programar(6ª Edição), e o livro comentava bastante os seus códigos fonte, principalmente no início.Além disso, também lia costantemente sobre a importância dessa prática em fóruns sobre Java, principalmente no fórum do GUJ.

É claro que como resultado desta nova exposição ao tema, desta vez já tendo bagagem suficiente para assimilá-lo, eu acabei adquirindo o costume de comentar os meus códigos.

Pecando pelo Excesso

Acontece que eu não apenas escrevia comentários, eu escrevia muitos deles, bem mais do que o necessário. Se não me engano, eles ocupavam pelo menos metade das linhas dos meus arquivos fonte.

É claro que na época eu já desconfiava que aquilo não era uma boa prática, mas, como aquele código tinha fins meramente didáticos, achei que não tinha problema. E de fato, nesse primeiro contato com os comentários, o excesso até pode ser algo bom, uma vez que dá prática na tarefa, o que pode vir a ser útil no futuro. Além disso, também serve para agilizar o aprendizado, uma vez que você acaba escrevendo conteúdo sobre o que está aprendendo.

Mas, em cenários reais, pecar pelo excesso é quase tão ruim quanto pecar pela ausência. Portanto, quando estiver escrevendo programas de verdade, análise os comentários no seu código e tente avaliar se não há mais do que o necessário. Mesmo sendo esta uma questão subjetiva, em geral, se você se sentir desconfortável, é porque provavelmente exagerou mesmo.

Por que é tão ruim?

Se você leu o post anterior, onde eu descrevo como uma irresponsabilidade o ato de não comentar o código de um programa, pode estar confuso agora sobre o porquê de eu estar chamando a atenção para o excesso de comentários. Acontece que a velha máxima também se aplica aqui: tudo em excesso é ruim.

Neste caso, é ruim porque idealmente um programa deve atingir o objetivo proposto com o mínimo de linhas possível, obviamente sem sacrificar a legibilidade do código. Dessa forma será mais rápido para criar o programa, para ler ele, e também para mantê-lo, já que os comentários devem ser atualizados junto com o código que descreve.

Contudo, quando escrevemos comentários demais, o número total de linhas do programa aumenta desnecessariamente, criando assim vários pontos de disperção, pois será gasto mais tempo em atividades que não agregam valor real.

Seja Preguiçoso!

Por fim, uma dica final que eu posso dar quanto a esse assunto é para você seguir o meu exemplo e ser preguiçoso. Sempre que você sentir aquela indisposição pra inserir um comentário em um determinado trecho do programa é porque provavelmente ele não merece existir. E se ele não merece existir, não há porque colocá-lo. Lembre-se, não exagere jamais no quantidade de comentários que você escreve em um programa.