Por favor, use este identificador para citar o enlazar este ítem:
https://hdl.handle.net/20.500.12104/95643| Título: | Towards a rubric proposal for the evaluation of the quality of code comments in Java Hacia una propuesta de rúbrica para la evaluación de la calidad de comentarios de código en Java |
| Palabras clave: | Comentario de código;Evaluación;Java;Software;Mantenimiento |
| Editorial: | Universidad de Guadalajara |
| Descripción: | In a software development, the documentation plays an important role for knowing the origin, details and reason to be, among other factors of a project. Its utility is wide and is extended even as support for future developers can continue the development with less difficulty. The code of a software is one of the most complex elements to understand, since each developer has their own style of programming. The best way for making the code understandable is accompany it with good comments all of them complete and consistent. In this article, we propose a rubric to evaluate the quality of code comments in Java. This rubric is divided into categories according to the type of comment to be assessed: copyright comment, class comment, method comment, and code snippet comment. Each category defines a set of rules that must be met to declare a comment has quality. Through the increment of readability and maintainability of code in software projects that are currently in use after using the rubric will help us to validate its effectiveness. Once this effectiveness has been verified, it will help the teams to have correctly commented codes and to reduce costs in the work of understanding and maintaining the code, since it will be more readable and descriptive. 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. |
| URI: | https://hdl.handle.net/20.500.12104/95643 |
| Otros identificadores: | http://recibe.cucei.udg.mx/index.php/ReCIBE/article/view/264 |
| Aparece en las colecciones: | Revista ReCIBE |
Ficheros en este ítem:
No hay ficheros asociados a este ítem.
Los ítems de RIUdeG están protegidos por copyright, con todos los derechos reservados, a menos que se indique lo contrario.