Guía del aspecto: Mantenibilidad
El aspecto de mantenibilidad responde a la pregunta que está detrás de casi todas las demás métricas: ¿cuánto va a costar cambiar este código sin romperlo? El tamaño, la complejidad, el acoplamiento o la duplicación miden propiedades sueltas; las métricas de este aspecto intentan resumirlas en un solo número, o comprobar después si el código ha resultado difícil de mantener.
La norma ISO/IEC 25010 trata la mantenibilidad como una característica de calidad del producto: la capacidad de modificarlo de forma efectiva y eficiente. La divide en cinco subcaracterísticas: modularidad, reusabilidad, analizabilidad, capacidad para ser modificado y capacidad para ser probado. Ninguna se puede leer directamente en el código. Por eso las métricas de este aspecto son de otra clase que las del resto de la referencia:
- una predicción a partir de métricas internas: el
«índice de mantenibilidad» (
MI) combina tamaño y complejidad en una fórmula ajustada a datos; - una estimación de coste a partir de reglas: el
«ratio de deuda técnica» (
TDR) suma los minutos que costaría corregir cada infracción encontrada y los divide entre el coste de escribir el código; - una observación: la «densidad de defectos» cuenta los defectos que se han encontrado de verdad, por unidad de tamaño.
Stau Metro no calcula ninguna de las tres. Sí calcula varios de sus ingredientes, que se detallan más abajo.
Para quien empieza. Un número de mantenibilidad es cómodo para ordenar, pero no dice qué arreglar. Cuando un módulo salga mal, la pregunta útil es siempre por qué, y la respuesta está en las métricas de los otros aspectos.
Por dónde empezar
Depende de los datos que tengas:
- Si usas una herramienta de reglas, como SonarQube, empieza por el «ratio de deuda técnica», y sobre todo por el del código nuevo: cada unidad de deuda corresponde a una infracción concreta, así que dice qué corregir.
- Si tienes un gestor de incidencias enlazado con el código, la «densidad de defectos» por módulo es la medida de resultado: dice dónde se ha fallado, no dónde se espera fallar. Para decidir dónde buscar, mira también el recuento sin dividir.
- Usa el «índice de mantenibilidad» cuando necesites comparar con Visual Studio o con la literatura. Para decidir qué refactorizar, mira directamente sus ingredientes.
Si no tienes nada de eso, no hay atajo: las métricas esenciales de «tamaño», «complejidad» y «acoplamiento» cubren lo que estas fórmulas resumen, y la «duplicación» añade lo que el índice de mantenibilidad no ve.
Las métricas del aspecto
| Métrica | De dónde sale | Unidad | Stau Metro | Qué dice |
|---|---|---|---|---|
«Índice de mantenibilidad» (MI) |
fórmula sobre V, v(G) y LOC |
puntos; más alto es mejor | no | Mantenibilidad predicha a partir del tamaño y la complejidad |
«Ratio de deuda técnica» (TDR) |
infracciones de reglas con coste de remedio | porcentaje; más alto es peor | no | Coste de corregir lo que ven las reglas frente al de escribir el código |
| «Densidad de defectos» | historial de incidencias y tamaño | defectos por mil líneas o por punto de función | no | Defectos encontrados por unidad de tamaño |
Tres enfoques, tres preguntas
MI |
TDR |
Densidad de defectos | |
|---|---|---|---|
| Pregunta | ¿cómo de mantenible debería ser? | ¿cuánto costaría dejarlo limpio? | ¿cuántos fallos ha dado? |
| Momento | antes, desde el código | antes, desde el código | después, desde el historial |
| Dice qué arreglar | no | sí: cada infracción | no, dice dónde |
| Escala de referencia | 85 y 65 (Coleman et al., 1994); 20 y 10 en la escala 0-100 de Visual Studio | calificaciones A-E de SonarQube (A hasta el 5 %) | ninguna universal |
| Punto débil | es sobre todo una medida logarítmica del tamaño | solo ve lo que las reglas activas saben ver | depende de cuánto se haya probado |
El índice de mantenibilidad (Oman y Hagemeister, 1992) es el que más críticas ha recibido. Sus coeficientes salen de un ajuste a pocos sistemas en C y Pascal, sus tres ingredientes crecen con el tamaño y la media por módulo esconde las partes de más riesgo. Su página muestra que quintuplicar la complejidad ciclomática de un método resta menos puntos que quintuplicar sus líneas. Van Deursen (2014) resume las críticas, y Heitlager, Kuipers y Visser (2007) propusieron un modelo que puntúa por separado volumen, complejidad, duplicación, tamaño de unidad y tests, precisamente para que el resultado diga qué mejorar.
La deuda técnica parte de la metáfora de Cunningham (1992) y del método SQALE de Letouzey: una definición de «código correcto» como lista de requisitos, cada uno con su coste de remedio. Su ventaja es que se puede sumar y descomponer; su límite, que los costes son convenciones y que el número cambia con el perfil de reglas. Dos herramientas no dan la misma deuda para el mismo código.
La densidad de defectos es la variable con la que se valida buena parte de las demás métricas. Tiene dos trampas que explica su página: una densidad baja puede ser código bueno o código que nadie ha probado, y dividir por el tamaño crea relaciones aparentes con el tamaño que El Emam et al. (2000) mostraron que eran un artefacto del cociente.
Ojo. No conviertas ninguno de los tres en objetivo de un equipo. El índice sube partiendo métodos sin pensar, el ratio baja desactivando reglas y la densidad baja registrando menos defectos.
Qué métricas de Stau Metro entran en sus fórmulas
El plugin calcula por separado varios ingredientes, pero no los combina. Con sus valores, por ejemplo exportados a CSV, se puede calcular a mano una aproximación; la tabla dice en qué se parece cada ingrediente al de la fórmula.
| Ingrediente | Fórmula | Métrica de Stau Metro | Diferencias |
|---|---|---|---|
| Volumen de Halstead | MI (versión modificada) |
«V»: HalsteadVolumeMethod, HalsteadVolumeClass |
En Java no hay acuerdo sobre qué es un operador o un operando; el plugin usa sus propias reglas de recuento |
| Esfuerzo de Halstead | MI (versión original) |
«E»: HalsteadEffortMethod, HalsteadEffortClass |
Las mismas reglas de recuento |
| Complejidad ciclomática extendida | MI |
«v(G)»: CyclomaticComplexity |
Cuenta && y ||, como la versión extendida; la media por paquete, módulo y proyecto es «v(G)avg», con el mismo recuento |
| Líneas de código | MI |
«LOC»: LinesOfCodeMethod, LinesOfCodeClass, LinesOfCodeInterface |
No cuenta las líneas vacías y sí las de comentario |
| Porcentaje de comentarios | MI (variante con comentarios) |
«COM_RAT», en todos los niveles |
Divide los comentarios entre las líneas no vacías, comentarios incluidos |
| Tamaño (denominador) | TDR, densidad de defectos |
«LOC» y «NCLOC» por paquete, módulo y proyecto |
La definición de línea cambia el resultado; hay que usar la misma en todo el cálculo |
Los numeradores de los otros dos no salen del código analizado: la deuda necesita un catálogo de reglas con costes y la densidad, el gestor de incidencias. Tres métricas del plugin se presentan con una intención parecida, y conviene no confundirlas:
- «Perfil de criterios de calidad (mantenibilidad)» (
QCP_MAINT): una suma ponderada de la longitud de Halstead, las sentencias, el anidamiento, las decisiones y los saltos de un método. No es el índice de mantenibilidad, y en ella más alto no es mejor. - «Número de comentarios TODO» (
TODO): la deuda que alguien anotó a mano. Cuenta marcas, no minutos. - «Errores estimados de Halstead» (
B): una predicción de defectos a partir del tamaño y la dificultad, no un recuento ni una densidad.
Cómo se combinan
Un índice compuesto se descompone antes de actuar. Si el MI de un módulo es bajo, mira sus ingredientes: casi
siempre domina el tamaño. Si la deuda es alta, repártela por regla y por característica, como propone SQALE, antes
de pagarla.
Predicción frente a resultado. MI y TDR miran el código; la densidad de defectos, lo que pasó. Cruzarlos dice
si las predicciones valen para tu sistema: si los módulos con peor índice no son los que más fallan, el índice no te
está ayudando.
El historial afina la prioridad. La deuda solo cobra interés en el código que se modifica. Un módulo con mucha deuda que nadie toca puede esperar; uno con deuda que cambia cada semana, no. Es la idea de los «puntos calientes de cambio»; la «guía de evolución» cuenta cómo cruzar el historial con las métricas del código.
Los tests cierran el círculo. Una densidad de defectos baja solo es buena noticia si el código se ha probado: léela con la «cobertura de código» y la «puntuación de mutación».
Qué no miden
- El diseño. Ni el índice ni la deuda ven una abstracción equivocada o una arquitectura que obliga a tocar diez módulos por cada cambio. Para eso están el «acoplamiento» y el «diseño de paquetes», y en el historial, el «acoplamiento de cambio».
- Si el código es fácil de entender. El índice usa medidas de tamaño y de complejidad que, como cuenta la «guía de complejidad», se relacionan poco con la comprensión medida en experimentos.
- El contexto del equipo. La misma base de código es más o menos mantenible según quién la conozca; eso lo aproxima la «propiedad del código», no estas métricas.
- El valor de un cambio. Un 5 % de deuda en el núcleo del producto pesa más que un 30 % en un módulo que se va a retirar.
Sjøberg, Anda y Mockus (2012) compararon cuatro implementaciones de un mismo sistema y concluyeron que el tamaño está infravalorado como medida de mantenibilidad y las métricas de mantenimiento más sofisticadas, sobrevaloradas. Es una buena razón para mirar primero las «líneas de código» antes que cualquier índice. La evidencia general está en «Qué dice la evidencia empírica», y las trampas de las medias por módulo, en «Agregar métricas».
Referencias
- ISO/IEC 25010, Systems and software engineering — Systems and software Quality Requirements and Evaluation (SQuaRE) — Product quality model (título de la edición de 2023, que sustituye a la de 2011). Resumen de la característica de mantenibilidad y sus subcaracterísticas en el portal ISO 25000, que no indica la edición: https://iso25000.com/index.php/normas-iso-25000/iso-25010?start=6
- Oman, P. y Hagemeister, J. (1992). «Metrics for Assessing a Software System's Maintainability». Proceedings of the Conference on Software Maintenance (ICSM), IEEE, 337-344.
- Coleman, D., Ash, D., Lowther, B. y Oman, P. (1994). «Using Metrics to Evaluate Software System Maintainability». IEEE Computer, 27(8), 44-49.
- Cunningham, W. (1993). «The WyCash Portfolio Management System». ACM SIGPLAN OOPS Messenger, 4(2), 29-30. Informe de experiencia de OOPSLA '92.
- Letouzey, J.-L. e Ilkiewicz, M. (2012). «Managing Technical Debt with the SQALE Method». IEEE Software, 29(6), 44-51.
- El Emam, K., Benlarbi, S., Goel, N., Melo, W., Lounis, H. y Rai, S. N. (2000). The Optimal Class Size for Object-Oriented Software: A Replicated Study. National Research Council Canada, informe ERB-1074.
- Heitlager, I., Kuipers, T. y Visser, J. (2007). «A Practical Model for Measuring Maintainability». 6th International Conference on the Quality of Information and Communications Technology (QUATIC 2007), 30-39.
- Sjøberg, D., Anda, B. y Mockus, A. (2012). «Questioning Software Maintenance Metrics: A Comparative Case Study». ESEM 2012, 107-110.
- Van Deursen, A. (2014). «Think Twice Before Using the "Maintainability Index"». https://avandeursen.com/2014/08/29/think-twice-before-using-the-maintainability-index/