Líneas de código (paquete, módulo, proyecto y tipo de fichero)
| Sigla | LOC (LOC(rec) en la variante recursiva del paquete) |
| Aspecto | «Tamaño» |
| Se mide en | paquete, módulo, proyecto, tipo de fichero |
| Tipo de valor | recuento (entero, mínimo 0) |
| Dirección | informativa: ni alto ni bajo es mejor |
| Stau Metro | LinesOfCodePackage, LinesOfCodeRecursivePackage, LinesOfCodeModule, LinesOfCodeProject, LinesOfCodeFileType |
Para métodos, clases e interfaces, ver «Líneas de código».
En pocas palabras
Suma las líneas no vacías de todos los ficheros de un paquete, un módulo, el proyecto entero o un tipo de fichero (Java, XML, HTML…). Da la escala: qué parte es grande y cuál pequeña. No es un objetivo ni bueno ni malo.
Qué mide
El volumen de texto de un conjunto de ficheros, comentarios incluidos. Sirve para comparar paquetes y módulos entre sí, para saber cuánto pesa cada tecnología (Java frente a XML, por ejemplo) y para tener un denominador al comparar otras cifras, como los tests o los comentarios.
Cómo se calcula
Para cada fichero se cuentan las líneas con algún carácter que no sea espacio ni tabulación, sobre el contenido del
fichero entero: cabecera de licencia, package, import y comentarios incluidos. Después se suman los ficheros
que pertenecen al elemento.
Por eso el total de un paquete no es la suma de las «LOC de sus clases»: faltan las líneas
fuera de las clases, y las anidadas se cuentan aparte.
Cómo interpretarla
No tiene umbrales. Úsala para decidir dónde mirar de cerca, no como meta:
- Un módulo mucho mayor que los demás es candidato a dividirse.
- La proporción entre tipos de fichero dice cuánto del proyecto es código y cuánto configuración o marcado.
- Seguida en el tiempo, muestra si el crecimiento se concentra en un sitio.
Compara siempre elementos de la misma naturaleza, y contrasta con las «líneas de código sin comentarios» si los comentarios o la documentación pesan mucho.
Relación con otras métricas
- «Líneas de código sin comentarios (agregadas)»: lo mismo sin las líneas que solo tienen comentarios.
- «Líneas de código de producción» (
LOCp) y «de test» (LOCt): el total repartido entre código que se entrega y tests. - «Líneas de Java», «Kotlin», «XML» y «HTML»: el total de módulo o proyecto restringido a un tipo de fichero.
- «Número de ficheros» (
FILES): dividiendo las líneas entre los ficheros sale el tamaño medio. - «Líneas de código»: la misma magnitud en método, clase e interfaz.
En las herramientas
Stau Metro.
- Paquete (
LinesOfCodePackage): los ficheros del directorio del paquete bajo una raíz de fuentes, sean Java o de otro tipo (un.propertiesjunto a las clases también suma). Los ficheros bajo una raíz de recursos ymodule-info.javano pertenecen a ningún paquete. La variante recursiva (LinesOfCodeRecursivePackage,LOC(rec)) suma también los subpaquetes; cada fichero cuenta una vez en cada paquete ascendiente. El paquete por defecto solo suma sus propios ficheros: no recibe el total de todos los demás. - Módulo (
LinesOfCodeModule) y proyecto (LinesOfCodeProject): todos los ficheros del contenido que visita la ejecución, de cualquier tipo, estén o no en una raíz de fuentes (README, scripts de construcción, documentación). No entran las raíces de fuentes generadas, las carpetas excluidas ni los ficheros de proyecto del propio IDE. - Tipo de fichero (
LinesOfCodeFileType): un valor por tipo de fichero presente, con todas sus líneas. - Los ficheros Java fuera de las raíces de fuentes Java (por ejemplo, bajo una raíz de recursos) no se analizan.
SonarQube separa lines (líneas físicas) de ncloc (sin blancos ni comentarios); el LOC de Stau Metro no
cuenta las vacías pero sí los comentarios.
Referencias
- Wikipedia, «Source lines of code»: https://en.wikipedia.org/wiki/Source_lines_of_code
- SonarQube, definición de métricas: https://docs.sonarsource.com/sonarqube-server/latest/user-guide/code-metrics/metrics-definition/