Comentários.
Um método está repleto de comentários explicativos.
##Sinais e sintomas
Um método está repleto de comentários explicativos.
// permitir o acesso aos administradores e ao proprietário
if (user.role == Role.ADMIN || order.ownerId == user.id) {
show(order);
}##Causas do problema
Os comentários geralmente são criados com as melhores intenções, quando o autor percebe que seu código não é intuitivo ou óbvio. Nesses casos, os comentários são como um desodorante que mascara o cheiro de um código suspeito que poderia ser melhorado.
O melhor comentário é um bom nome para um método ou classe.
Se você acha que um trecho de código não pode ser entendido sem comentários, tente alterar a estrutura do código de uma forma que torne os comentários desnecessários.
##Tratamento
##Benefícios
- O código se torna mais intuitivo e evidente.
