Comentários de código (série Code Smells)

Dizer que comentário de código é mau cheiro não quer dizer que nunca devermos escrever comentários. Não estou afirmando isto, mas tome muito cuidado ao comentar seu código. Fowler et al (2002, p.71) afirmam que muitas vezes os comentários são usados como desodorante. A primeira ação a ser tomada é a eliminação dos maus cheiros, que possivelmente estão ao redor deste tipo de comentário. A primeira ação a ser tomada é refatorar. Quando você terminar, verá que os comentários serão supérfluos. Continuando nesta mesma ideia, Fowler demonstra quais métodos de refatoração utilizar diante de algumas necessidades de refatoração. Veja como faz sentido:

  • “Precisa de um comentário para explicar o que o bloco de código faz”? Use Extrair Método.
  • “Já extraiu o método e mesmo assim ainda precisa explicar?” Use Renomear Método.
  • “Precisa indicar algumas regras sobre o estado do sistema?” Use Introduzir afirmação.

Realize os procedimentos explicados acima e assim que terminar analise novamente se seus comentários ainda são necessários. Provavelmente não serão. Portanto, você deve usar comentários:

  • Quando não sabe exatamente o que fazer;
  • Para descrever o que está acontecendo;
  • Para explicar por que fez aquilo.

Este tipo de comentário com certeza irá ajudar os possíveis modificadores daquela parte do código.

Referências

Anúncios

Deixe uma Resposta

Preencha os seus detalhes abaixo ou clique num ícone para iniciar sessão:

Logótipo da WordPress.com

Está a comentar usando a sua conta WordPress.com Terminar Sessão / Alterar )

Imagem do Twitter

Está a comentar usando a sua conta Twitter Terminar Sessão / Alterar )

Facebook photo

Está a comentar usando a sua conta Facebook Terminar Sessão / Alterar )

Google+ photo

Está a comentar usando a sua conta Google+ Terminar Sessão / Alterar )

Connecting to %s