Page tree

 

Ya soy un experto y estoy aquí para ayudar: ¡contesta preguntas pendientes y gana puntos!

Skip to end of metadata
Go to start of metadata

Tabla de contenidos

Introducción

Un código fuente legible e inteligible tiene que ser un equilibrio entre:

  • Documentar bloques de código complejos y sencillos
  • Escenarios legibles de pruebas unitarias que permiten a los desarrolladores entender el código
  • APIs documentadas que permitan a los desarrolladores externos a entender como se usa esa API
  • Cumplimiento de los estándares de código como por ejemplo nomenclatura

Con demasiados comentarios podrías estar incurriendo en los siguientes problemas:

  • Mantenimiento excesivo que ocupa tiempo y que te llevará a dejar comentarios sin actualizar. Los comentarios pasan a estar en contra de su objetivo principal y pueden hacer que el desarrollador malentienda los fragmentos y pierda más tiempo entendiendo el código.
  • Si el código fuente necesita demasiados comentarios, entonces significa que no están respetando los estándares de codificación (nomenclatura, diseño, etc.) o que es demasiado complejo.

Monitorizar los comentarios

Widget

Añade el widget de Documentación y comentarios (que era Comentarios y Duplicados en versiones anteriores a la 3.7) a tu cuadro de mando de proyecto:

Regla: código comentado (Commented-out Code)

Para algunos lenguajes está disponible una regla para detectar bloques de código que se han añadido como comentarios. Estos bloques no deberían nunca existir, ya que con un control de versiones siempre podemos volver al pasado para saber el código que estaba antes en ese lugar.

  • No labels