ReCIBE (Jun 2023)
Hacia una propuesta de rúbrica para la evaluación de la calidad de comentarios de código en Java
Abstract
En un desarrollo de software la documentación juega un papel importante para conocer el origen, detalles, razón de ser, entre otros factores de un proyecto. Su utilidad es muy amplia y se extiende incluso como apoyo para que futuros desarrolladores puedan darle continuidad al sistema con menores dificultades. El código de un software es de los elementos más complejos de entender, ya que cada desarrollador posee una forma propia de programar. La manera por excelencia para hacer un código entendible es acompañarlo de buenos comentarios: completos y consistentes. En este artículo proponemos una rúbrica para evaluar la calidad de comentarios de código en Java. Dicha rúbrica está dividida por categorías según el tipo de comentario a evaluar: comentario de autoría, comentario de clase, comentario de método y comentario de fragmento de código, cada categoría establece un conjunto de reglas que deben cumplirse para declarar que un comentario es de calidad. El aumento en la legibilidad y mantenibilidad del código en proyectos de software que se encuentran actualmente en uso después de haber usado la rúbrica nos ayudará a validar su efectividad. Una vez comprobada esta eficacia ayudará a los equipos a poseer códigos correctamente comentados y a reducir costes en labores de entendimiento y mantenimiento del código pues este será más legible y descriptivo.
Keywords
