Comentarios - Código basura

Este post es uno más de la serie "Comentarios - No, no, y no". El listado completo de artículos de la serie se encuentra relacionado al final del post.

Código basura es todo aquel que pierde su razón de existencia y en vez de ser eliminado, es comentado y abandonado entre líneas. Esta es la forma más común de los comentarios, y la más molesta, dañina, e innecesaria. Un ejemplo:

if (a == 1 /*|| b == 1 || c == 1*/) {
    System.out.println("Here we are!");
}

La condición anterior obviamente ya no necesita la sección comentada, pero en vez de eliminarla la dejamos allí con el objetivo de... ¿confundir? No veo otro.

La razón fundamental para dejar código comentado de esta manera es no eliminar un código que luego nos puede servir. Sorry, pero para eso existen los sistemas de versionamiento de código (CVS, SVN, GIT, etc.). En último caso, podemos hacerle una copia al fichero y guardarlo de recuerdo, pero el comentario... no tiene justificación.

Respond via Twitter →