Índice de mantenibilidad
| Sigla | MI |
| Aspecto | «Mantenibilidad» |
| Se mide en | módulo (rutina) y sistema, con medias por módulo; algunas herramientas lo dan por método, tipo y proyecto |
| Tipo de valor | puntuación con decimales; sin acotar en la fórmula original, de 0 a 100 en la variante de Visual Studio |
| Dirección | más alto es mejor |
| Umbrales de referencia | 85 y 65 en la fórmula original (Coleman et al., 1994); 20 y 10 en la escala 0-100 de Visual Studio |
| Origen | Paul W. Oman y Jack Hagemeister, 1992 |
| Stau Metro | no la calcula |
En pocas palabras
Resume en un solo número lo fácil que debería ser mantener un trozo de código. Mezcla tres medidas que ya conoces por separado: lo grande que es, cuántas decisiones toma y cuánto «vocabulario» usa. Cuanto más alto, mejor. Es cómodo para ordenar módulos de peor a mejor, pero el número en sí no explica qué falla.
Qué mide
Pretende estimar la mantenibilidad: el esfuerzo que cuesta entender, corregir y modificar el código. No la mide directamente, porque no hay forma de medirla en el código; la predice a partir de medidas internas que sí se pueden contar.
La fórmula es un polinomio ajustado a mediciones de sistemas reales, calibradas con la opinión de los técnicos que los mantenían (así lo resumen Heitlager, Kuipers y Visser, 2007); de ahí el título del trabajo de Oman y Hagemeister de 1994, «construcción y prueba de polinomios que predicen la mantenibilidad». Sus coeficientes salen de aquel ajuste, no de ningún principio.
Los ingredientes:
- el «volumen de Halstead» (o, en la primera versión, el «esfuerzo de Halstead» ): tamaño medido en operadores y operandos;
- la «complejidad ciclomática» : decisiones;
- las «líneas de código»: tamaño en líneas;
- en algunas variantes, el porcentaje de líneas de comentario.
Para quien empieza. Un índice compuesto es cómodo de leer, pero esconde de dónde viene el valor. Si un módulo sale mal, mira sus tres ingredientes por separado: casi siempre es el tamaño.
Cómo se calcula
Welker (2001) recoge las ecuaciones originales y las modificadas. En todas, cada medida es la media por módulo del sistema analizado (en los sistemas de C y Pascal de los estudios originales, un módulo es una rutina).
Versión original, con el esfuerzo de Halstead («de 3 métricas»):
La «de 4 métricas» suma , donde es el número medio de líneas de comentario por módulo.
Versión modificada, con el volumen de Halstead, que es la que se usa hoy:
y su variante con comentarios suma
donde es el porcentaje medio de líneas de comentario por módulo. El coeficiente 2,46 es el de Welker y de
Heitlager et al.; otras fuentes, como Radon o Verifysoft, escriben 2,4. es la complejidad ciclomática
extendida (la que cuenta también && y ||) y es el logaritmo neperiano.
Welker explica el cambio: había más confianza en el volumen de Halstead que en su esfuerzo, y el término lineal de comentarios pesaba demasiado, así que se sustituyó por uno acotado (el seno nunca pasa de 1, así que el término aporta como mucho 50 puntos).
Variante de Visual Studio. Usa la fórmula modificada sin comentarios, corta los valores negativos en 0 y la reescala de 0 a 100:
Ejemplo
Calcular a mano el volumen de Halstead de un método real es largo (está en su «propia página»), así que el ejemplo parte de valores ya medidos. Supón dos métodos:
| Método pequeño | 1000 | 5 | 40 |
| Método grande | 8000 | 25 | 200 |
Método pequeño:
En la escala de Visual Studio, : verde.
Método grande:
En la escala de Visual Studio, : amarillo, por los pelos.
Fíjate en el reparto. Quintuplicar la complejidad ciclomática (de 5 a 25) resta solo 4,6 puntos; quintuplicar las líneas (de 40 a 200) resta 26,1. El índice es, sobre todo, una medida logarítmica del tamaño.
Cómo interpretarla
| Escala | Bueno | Moderado | Difícil de mantener | Procedencia |
|---|---|---|---|---|
| Original (sin acotar) | 85 o más | de 65 a 85 | menos de 65 | Coleman et al. (1994) |
| Visual Studio (0-100) | de 20 a 100 | de 10 a 19 | de 0 a 9 | documentación de Visual Studio |
Las dos escalas no son intercambiables. Un 65 en la original equivale a 38 en la de Visual Studio, que ahí sale verde. Microsoft explica que eligió umbrales conservadores a propósito: quería que el rojo señalara un problema «con un alto grado de confianza» y mantener bajo el ruido.
Qué hacer con un valor bajo. El índice no dice qué arreglar. Descompón el valor en sus ingredientes y ataca el que domina, que casi siempre es el tamaño: extrae métodos, divide clases. Si domina la complejidad ciclomática, simplifica las decisiones.
Cuándo un valor bajo es aceptable. Código generado, tablas de datos escritas como código o un método largo pero lineal pueden salir mal sin ser difíciles de mantener.
Ojo. Un índice medio alto en un sistema no garantiza nada: la media de muchos módulos pequeños y sencillos esconde los pocos grandes donde se concentran los problemas. Mira los peores, no la media (ver «Agregar métricas»).
Para profundizar
Historia de las versiones. Welker sitúa el origen en 1991; la publicación de referencia es la de Oman y Hagemeister en ICSM 1992, ampliada en 1994 en el Journal of Systems and Software. Coleman, Ash, Lowther y Oman la difundieron ese mismo año en IEEE Computer, con los umbrales de 85 y 65. Welker (2001) insiste en que la elección de la ecuación «sigue siendo objeto de discusión» y aconseja no cambiarla a mitad de la vida de un sistema si se usa para seguir su evolución.
El término de comentarios. Welker recomienda revisar a mano los comentarios antes de fiarse de la versión de 4 métricas: unos comentarios desfasados suben el índice sin hacer el código más mantenible. Propone como señal de alarma una diferencia de más de 15 puntos entre la versión de 3 y la de 4 métricas. Hay además un problema de unidades: el seno es periódico, de modo que si va de 0 a 100, oscila entre −50 y 50. Liso (2001) lo señaló en el mismo número de CrossTalk: la función tiene máximos hacia el 1 %, el 25 % y el 81 % de comentarios, y baja entre el 1 % y el 9 %, cuando debería subir. Las implementaciones no coinciden en cómo resolverlo: Radon, por ejemplo, documenta que convierte el porcentaje a radianes antes de aplicar la fórmula.
Críticas. Van Deursen (2014) resume las principales:
- la fórmula no tiene una explicación, solo un ajuste;
- sus tres ingredientes están directamente correlacionados con el tamaño;
- las medias por módulo ocultan las partes de más riesgo, porque estas métricas siguen distribuciones muy sesgadas;
- se calibró con pocos programas pequeños en C y Pascal, sin significación estadística, y las herramientas reutilizan los coeficientes sin recalibrarlos para Java o C#.
Welker ya advertía de lo último para la orientación a objetos: los métodos suelen ser pequeños, el índice tiende a salir alto, y quizá habría que subir los umbrales.
Heitlager, Kuipers y Visser (2007) añaden otras desde la práctica de consultoría: un valor compuesto no dice qué lo causa ni qué hacer para mejorarlo; la media de la complejidad es engañosa porque en Java los getters y setters valen 1 y la bajan; el volumen de Halstead es difícil de definir en Java o C#, donde no hay acuerdo sobre qué es un operador o un operando; y las líneas de comentario no guardan relación con la mantenibilidad, porque muchas veces son código comentado.
Alternativas. Heitlager, Kuipers y Visser propusieron un modelo práctico que puntúa por separado volumen, complejidad por unidad, duplicación, tamaño de unidad y tests, y los relaciona con las subcaracterísticas de mantenibilidad de ISO 9126, precisamente para que el resultado diga qué mejorar. Sjøberg, Anda y Mockus (2012) compararon cuatro implementaciones independientes 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.
Relación con otras métricas
- «Volumen de Halstead» (
V) y «esfuerzo de Halstead» (E): el primer ingrediente, en la versión modificada y en la original. - «Complejidad ciclomática» (
v(G)): el segundo ingrediente, el que menos pesa. - «Líneas de código» (
LOC): el tercer ingrediente y el que más pesa; léelas junto al índice para ver si dicen lo mismo. - «Ratio de comentarios» (
COM_RAT): próxima al porcentaje de comentarios que usa la variante de 4 métricas. - «Perfil de criterios de calidad (mantenibilidad)» (
QCP_MAINT): otra puntuación compuesta orientada al mantenimiento, con otros ingredientes y pesos. - «Ratio de deuda técnica» (
TDR): el enfoque que la ha sustituido en muchas herramientas; en lugar de una fórmula sobre métricas, suma el coste de corregir infracciones concretas. - «Densidad de líneas duplicadas»: la duplicación, que el índice no ve, es uno de los factores de mantenibilidad que sí tienen en cuenta los modelos alternativos.
En las herramientas
Stau Metro no la calcula. Calcula por separado sus tres ingredientes: el volumen de Halstead por método y por
clase (V), la complejidad ciclomática por método (v(G)) y las líneas de código. Su métrica más parecida en
intención es el «perfil de criterios de calidad (mantenibilidad)»
(QCP_MAINT), que no es este índice: es una suma ponderada de la longitud de Halstead, las sentencias ejecutables y
de control, el anidamiento, las decisiones y los saltos de un método, y en ella más alto no es mejor.
Visual Studio (Code Metrics). Calcula el índice entre 0 y 100 con la fórmula reescalada de arriba, sin término de comentarios, y lo colorea: verde de 20 a 100, amarillo de 10 a 19 y rojo de 0 a 9. Las métricas se generan para una solución o un proyecto, y por tipo y método.
Radon (Python). Documenta cuatro fórmulas: la original, la del SEI (con logaritmos en base 2 y el término de comentarios), la de Visual Studio y la suya propia, que combina las dos últimas: reescalada de 0 a 100 y con el término de comentarios, cuyo porcentaje convierte a radianes.
Testwell CMTJava (Verifysoft). Calcula la versión con comentarios como suma de dos partes, el índice sin comentarios y el peso de los comentarios, con las medias por módulo del volumen de Halstead, la complejidad ciclomática extendida y las líneas físicas, y aplica los umbrales 85 y 65.
Referencias
- 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.
- Oman, P. y Hagemeister, J. (1994). «Construction and Testing of Polynomials Predicting Software Maintainability». Journal of Systems and Software, 24(3), 251-266.
- Coleman, D., Ash, D., Lowther, B. y Oman, P. (1994). «Using Metrics to Evaluate Software System Maintainability». IEEE Computer, 27(8), 44-49.
- Welker, K. D. (2001). «The Software Maintainability Index Revisited». CrossTalk, agosto de 2001, 18-21.
- Liso, A. (2001). «Software Maintainability Metrics Model: An Improvement in the Coleman-Oman Model». CrossTalk, agosto de 2001, 15-17.
- 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/
- Microsoft, Visual Studio: «Maintainability index range and meaning»: https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-maintainability-index-range-and-meaning y «Code metrics values»: https://learn.microsoft.com/en-us/visualstudio/code-quality/code-metrics-values
- Radon, documentación: https://radon.readthedocs.io/en/latest/intro.html
- Verifysoft, Testwell CMT++/CMTJava, «Maintainability Index»: https://verifysoft.com/en_maintainability.html