CheckStyle comentarios

O CheckStyle e o PMD não acham “códigos comentados” porque não olham dentro dos comentários (apenas dos javadocs, para ver se eles estão coerentes e corretos). Entretanto, tanto o PMD quanto o CheckStyle podem checar para ver se há código repetido (“copy & paste”).

Pense bem comigo: como é que eu sei que um comentário é lixo ou se é válido? Não é fácil saber (embora eu saiba só de olhar um “comentário lixo”, é difícil implementar isso em código.)

Se quiser, defina corretamente o que é um “comentário lixo” e implemente um módulo para o PMD ou CheckStyle. Eles agradecem sua colaboração.

Uma regra simples seria: se algo parece Java, e está comentado, então é um comentário lixo. Mas e isto?

/**
 * Exemplo de uso 
 * <pre>
 * Map < String, Integer > freq = new TreeMap < String, Integer > ();
 * </pre>
 */

Isto é um comentário legítimo que contém código - exemplo. Isso é lixo?

Entretanto, eles acham bastante lixo, como variáveis locais não usadas, campos privados não usados, código que nunca será executado etc. Não deixe de usar o PMD e o CheckStyle.

if (false) {
    int x = y / 0;
}

Acho que eles indicam que a linha “x = y / 0” nunca será executada, e portanto é lixo.

e verdade mas se tivesse um modulo que apenas mostrasse codigos comentados ja ajudaria bastante pois dai vc olhando eles direto onde tem vc pode ver o que e e o que não é lixo…

ps: algumas validações dessas de código inútil já são implementadas diretamente no eclipse e não necessitam de plugins.