Início > Qualidade de Código > Comentários de Código

Comentários de Código

Comentário ruim no códigoGeralmente, quando estamos escrevendo nossos códigos temos a preocupação (ou a necessidade) de explicar certas partes que podem não estar tão claras. Utilizamos, então, comentários para esclarecer o propósito daquela função, variável ou classe.

Muito embora essa prática alcance seu objetivo imediato, ela esconde uma verdade importante: se o código precisa ser explicado, então ele não está bem escrito o bastante; ele é um código ruim.

Além disso, comentários são muitas vezes traiçoeiros. O código muda bastante e na maioria das vezes o programador acaba esquecendo de refletir essas mudanças em seus comentários.

Exemplo 1:


   //Retorna o cliente passando o ID como parâmetro
   public Cliente GetCliente(string CPF) {...}

Note que o programador esqueceu de alterar o nome do parâmetro de ID para CPF em seu comentário, trazendo uma informação errada para o seu código.

Outro uso negativo dos comentários é a redundância de informação, como mostra o exemplo abaixo:

Exemplo 2:


public class Cliente
{
    //Data de Nascimento
    private DateTime dataNascimento;

    //Nome do Cliente
    private string nome;
}

Neste caso, a informação dos comentários não agrega valor algum ao entendimento do código. A melhor escolha seria não utilizá-los.

Na maioria das vezes, um comentário pode ser substituído refatorando (e melhorando) o código. Nos casos em que o comentário for realmente necessário, ele deverá ser curto e direto.

Exemplo 3:

   /* O método ExecuteUpdateAsAdministrator não é Thread Safe */
   public void ExecuteUpdateAsAdministrator() {...}

O exemplo 3 mostra uma boa utilização de comentário, alertando o programador sobre uma consequência do uso do código.

Assim, tente diminuir o uso dos comentários. Refaça o código e altere o nome das entidades. Seu código ficará muito mais fácil de ser entendido.

Anúncios
  1. Nenhum comentário ainda.
  1. No trackbacks yet.

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: