¿Cómo manejan los ingenieros de software los comentarios obsoletos en el código?

Revisiones de código! Cuando cambia el código, lo pone a revisión. Los revisores vendrán, uno de los cuales podría no saber exactamente lo que hace, leerá los comentarios y luego el código. Darse cuenta de la coincidencia y hacer un comentario en la revisión.

No es infalible, pero generalmente capta la mayoría de los problemas. (Siempre que tenga revisores diligentes).

O cuando está aprendiendo lo que hace algo, al leerlo, se da cuenta de que el comentario es obsoleto y agrega los cambios para corregirlo en su próxima confirmación.

Me encuentro con comentarios desactualizados en tres escenarios:

1. Cuando trabajo en algo yo mismo
2. Al leer diferencias en una solicitud de revisión de código
3. Por casualidad, cuando estoy leyendo el código para entender algo que mi código llama

Creo que es importante mantener los comentarios precisos. Especialmente si usa un sistema como Sphinx (que hace mi equipo) o JavaDoc para generar documentación separada. Pero, en cualquier caso, los malos comentarios son un problema de “ventanas rotas” que eventualmente enseñarán a las personas a ignorar los comentarios y a omitirlos incluso cuando sean importantes.

El número 3 no suele valer la pena actuar en consecuencia.

Pero para el n. ° 1, donde el comentario está en el código que estoy tocando de todos modos, lo actualizo o elimino según corresponda.

Para el n. ° 2 marco las líneas ofensivas en mi reseña. También trato de ofrecer una redacción sugerida, ya que eso hace más probable que se realice el cambio.

Si, esto pasa. Si cambia el código para que el comentario ya no se aplique, vuelva a escribir el comentario. En general, no hacer demasiados comentarios, solo cuando un fragmento de código se beneficiaría de un comentario, es generalmente el camino a seguir por la misma razón que usted dice.