Hacia una propuesta de rúbrica para la evaluación de la calidad de comentarios de código en Java
DOI:
https://doi.org/10.32870/recibe.v12i1.264Palabras clave:
Comentario de código, Evaluación, Java, Software, MantenimientoResumen
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ódigoentendible 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 estaeficacia 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.Citas
Aman, H., Amasaki, S., Yokogawa, T., & Kawahara, M. (2016). A Doc2Vec-Based Assessment of
Comments and Its Application to Change-Prone Method Analysis. https://bit.ly/2Pb89Au
Bai, Y., Zhang, L., & Zhao, F. (2019). A survey on research of code comment. ACM International
Conference Proceeding Series, 45–51. https://doi.org/10.1145/3312662.3312710
How and When to Deprecate APIs. (n.d.). Retrieved November 22, 2022, from
https://docs.oracle.com/javase/7/docs/technotes/guides/javadoc/deprecation/deprecation.html
How to Write Doc Comments for the Javadoc Tool. (n.d.). Retrieved November 22, 2022, from
https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html#tag
Iammarino, M., Aversano, L., Bernardi, M. L., & Cimitile, M. (2019). A Topic Modeling Approach To
Evaluate The Comments Consistency To Source Code. In IEEE Xplore.
Rani, P. (2021). Speculative Analysis for Quality Assessment of Code Comments. Proceedings -
International Conference on Software Engineering, 299–303. https://doi.org/10.1109/ICSECompanion52605.2021.00132
Real Academia Española. (n.d.). Derecho de autor. Retrieved November 7, 2022, from
https://dle.rae.es/derecho#MYrPxAp
Steidl, D., Hummel, B., & Juergens, E. (2013). Quality Analysis of Source Code Comments. In 2013 IEEE
st International Conference on Program Comprehension (pp. 83–92). IEEE.
Wang, D., Guo, Y., Dong, W., Wang, Z., Liu, H., & Li, S. (2019). Deep Code-Comment Understanding
and Assessment. IEEE Access, 7, 174200–174209. https://doi.org/10.1109/ACCESS.2019.2957424
Woodfield, S. N., Dunsrnore, H. E., & Shen, V. Y. (1981). The Effect of Modularization and Comments on
Program Comprehension.
