Líneas de código sin comentarios (paquete, módulo, proyecto y tipo de fichero)
| Sigla | NCLOC (NCLOC(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 | SourceLinesOfCodePackage, SourceLinesOfCodeRecursivePackage, SourceLinesOfCodeModule, SourceLinesOfCodeProject, NonCommentLinesOfCodeFileType |
Para métodos, clases e interfaces, ver «Líneas de código sin comentarios», que es la definición de la métrica.
En pocas palabras
Suma, en un paquete, un módulo, el proyecto o un tipo de fichero, las líneas que tienen código: sin las vacías y sin las que solo contienen un comentario. Sirve para comparar el tamaño de las partes de un sistema sin que la documentación lo altere.
Qué mide
El volumen de código sin el efecto de los comentarios. Dos módulos con el mismo código pero distinta documentación dan el mismo valor.
Cómo se calcula
Por cada fichero: líneas no vacías menos líneas que solo contienen comentario (ver la «definición»).
Después se suman los ficheros del elemento. Se aplica al fichero entero, con su cabecera de licencia y sus
import.
La resta de comentarios se hace con los comentarios que el analizador del IDE reconoce en cada lenguaje (por ejemplo
<!-- --> en XML y HTML), así que se aplica también a ficheros que no son Java.
Cómo interpretarla
Sin umbrales: es informativa. Úsala para localizar los elementos más grandes y como denominador de otras cifras.
Compárala con el «LOC» del mismo elemento: la diferencia es lo que tiene de comentario.
Relación con otras métricas
- «Líneas de código sin comentarios»: la versión por método, clase e interfaz.
- «Líneas de código (agregadas)»: lo mismo contando también las líneas de comentario.
- «Líneas de código sin comentarios (producción)» (
NCLOCp) y «(test)» (NCLOCt): la misma suma limitada a producción o a tests. - «Líneas de comentario» (
CLOC): las líneas de comentario. - «Ratio real de comentarios» (
TCOM_RAT): las líneas que solo tienen comentario divididas entreNCLOC.
En las herramientas
Stau Metro. Paquete (SourceLinesOfCodePackage), variante recursiva (SourceLinesOfCodeRecursivePackage,
NCLOC(rec), con los subpaquetes, sin contar dos veces un fichero), módulo (SourceLinesOfCodeModule), proyecto
(SourceLinesOfCodeProject) y tipo de fichero (NonCommentLinesOfCodeFileType; su id no sigue el patrón
SourceLinesOfCode* de los demás).
- Los ficheros de texto plano (
.txty los demás que el IDE trata como texto) no son código: no suman y no crean fila. Esto vale también en el tipo de fichero, donde el texto plano no aparece. Un fichero de otro tipo reconocido, como un README en Markdown, sí suma. - En módulo y proyecto cuentan todos los ficheros del contenido que visita la ejecución, tengan o no relación con las raíces de fuentes (README, scripts de construcción, documentación), salvo las raíces de fuentes generadas, las carpetas excluidas y los ficheros de proyecto del propio IDE.
- El paquete suma los ficheros de su directorio bajo una raíz de fuentes, sean Java o no. Los ficheros bajo raíces
de recursos y
module-info.javano pertenecen a ningún paquete. - Los ficheros Java fuera de las raíces de fuentes Java no se analizan.
- El paquete por defecto solo suma sus propios ficheros en la variante recursiva.
SonarQube define ncloc como las líneas físicas con al menos un carácter que no sea espacio, tabulación ni
parte de un comentario. Es el mismo criterio por fichero; las diferencias pueden venir de qué ficheros entran en cada
herramienta.
Referencias
- SonarQube, definición de métricas: https://docs.sonarsource.com/sonarqube-server/latest/user-guide/code-metrics/metrics-definition/
- Wikipedia, «Source lines of code»: https://en.wikipedia.org/wiki/Source_lines_of_code