Líneas de código sin comentarios (test)
| Sigla | NCLOCt (NCLOCt(rec) en la variante recursiva del paquete) |
| Aspecto | «Tests» |
| Se mide en | paquete, módulo, proyecto |
| Tipo de valor | recuento (entero, mínimo 0) |
| Dirección | informativa: ni alto ni bajo es mejor |
| Stau Metro | SourceLinesOfCodeTestPackage, SourceLinesOfCodeTestRecursivePackage, SourceLinesOfCodeTestModule, SourceLinesOfCodeTestProject |
En pocas palabras
Son las «líneas de código de test» menos las que contienen solo comentarios. Da una idea más ajustada de cuánto código hay en la suite: declaraciones, preparación, llamadas y aserciones, sin la documentación.
Qué mide
El tamaño del código de test descontando la documentación. Un test muy comentado y uno sin comentarios con la misma
lógica tienen el mismo NCLOCt y distinto LOCt. La diferencia entre las dos métricas es la parte de la suite que
son comentarios.
Cómo se calcula
Una línea que mezcla código y un comentario al final cuenta como código. Una línea que solo contiene un comentario (de línea, de bloque o Javadoc) no cuenta; en un comentario de bloque de varias líneas, no cuenta ninguna.
Cómo interpretarla
Sin valor bueno ni malo y sin umbrales. Úsala en lugar de LOCt cuando quieras comparar suites de estilos de
comentario distintos, y junto a LOCt para saber cuánto comentario hay. Si ambas son casi iguales, el código de
test casi no tiene comentarios, algo habitual y no necesariamente un problema: un test legible se explica con el
nombre y las aserciones.
Relación con otras métricas
- «Líneas de código de test» (
LOCt): el total del que esta métrica descuenta los comentarios. - «Líneas de código sin comentarios» (
NCLOC) y «de producción» (NCLOCp): la misma medida sobre todo el código y sobre el de producción. - «Líneas de comentario» (
CLOC): las líneas de comentario del elemento, de test o no. - «Ratio de test» (
TEST_RAT): usa las líneas totales, no las que no son comentario.
En las herramientas
Stau Metro (SourceLinesOfCodeTestPackage, SourceLinesOfCodeTestRecursivePackage,
SourceLinesOfCodeTestModule, SourceLinesOfCodeTestProject). Selecciona los mismos ficheros que LOCt (fuentes de
test, sin raíces de recursos) y resta de sus líneas no vacías las que contienen solo comentario. Esto último se
reconoce con el analizador del lenguaje de cada fichero, de modo que un comentario XML o de Kotlin también cuenta como
comentario.
Una diferencia con LOCt: los ficheros de texto plano no se consideran código fuente y no suman nada, ni crean fila.
Con ficheros .txt en las raíces de test, LOCt puede ser mayor que NCLOCt más las líneas de comentario.
SonarQube define sus líneas de código (ncloc) como las líneas físicas con al menos un carácter que no sea
espacio, tabulador ni parte de un comentario. La página de definiciones de métricas no indica si los ficheros de test
se excluyen de ese recuento por defecto.
Referencias
- SonarQube, definición de métricas: https://docs.sonarsource.com/sonarqube-server/latest/user-guide/code-metrics/metrics-definition/