Líneas de código sin comentarios
| Sigla | NCLOC (non-comment lines of code) |
| Aspecto | «Tamaño» |
| Se mide en | método, clase, interfaz |
| Tipo de valor | recuento (entero, mínimo 0) |
| Dirección | más alto es peor |
| Umbrales de referencia | en método: aviso por encima de 30, error por encima de 100 (Stau Metro) |
| Stau Metro | SourceLinesOfCodeMethod, SourceLinesOfCodeClass, SourceLinesOfCodeInterface |
En Stau Metro el id contiene SourceLinesOfCode y la sigla es NCLOC. La versión para paquetes, módulos, proyectos
y tipos de fichero está en «otra página».
En pocas palabras
Cuenta las líneas que contienen código: ni las vacías ni las que solo tienen un comentario. Documentar un método no lo hace crecer, y por eso es la medida que se usa para decir que un método o una clase es demasiado largo.
Qué mide
El tamaño del código en sí. Es la versión «física sin comentarios» de las líneas de código, la que suele entenderse por SLOC (ver «Para profundizar»). Sirve para tres cosas:
- Encontrar métodos que hacen demasiado: los muy largos suelen mezclar varias tareas.
- Encontrar clases que han crecido sin control.
- Comparar elementos de un mismo proyecto.
Para quien empieza. No necesitas saber qué hace el código para calcularla: basta con contar las líneas con algo de código. Una línea como
int x; // contadorcuenta, porque tiene código aunque lleve un comentario.
Cómo se calcula
Una línea es vacía si solo tiene espacios y tabulaciones. Una línea es solo de comentario si todo lo que no
es espacio en blanco pertenece a comentarios: un //, una línea de un /* ... */ de varias líneas o una línea de
Javadoc. Un bloque comentado se cuenta línea a línea. Una línea que mezcla código y comentario (int a; /* c */ int b;
o int x; // nota) cuenta como código. Varios comentarios en una misma línea restan una sola vez.
Las llaves, las anotaciones y la firma cuentan como código aunque estén en una línea propia.
Ejemplo
/** Outer. */ // comentario: no cuenta
public class Outer { // 1
// a comment // comentario: no cuenta
int x; // 1
static class Inner { // pertenece a Inner
/* inner */
int y;
}
void m() { // 1
class Local { // 1
int z; // 1
} // 1
} // 1
} // 1
En Outer quedan 14 líneas no vacías; se restan las 4 de Inner (10) y las 2 de comentario: NCLOC(Outer) = 8.
Inner tiene 4 líneas y una de comentario: NCLOC(Inner) = 3. El método m vale 5. Son los valores que fija un test
del proyecto con este código.
Cómo interpretarla
En un método. Stau Metro marca aviso por encima de 30 líneas y error por encima de 100 (valor > umbral). Son
umbrales de referencia del propio plugin, una convención y no valores publicados en la literatura. Como orientación
de otra fuente, la comprobación MethodLength de Checkstyle limita por defecto a 150 líneas, pero cuenta también las
vacías y los comentarios.
Un método largo no es un defecto en sí. Lo que importa es qué hay dentro: un método de 60 líneas que pasa datos de un formato a otro es aceptable; uno de 40 con bucles y condiciones anidadas no. Léelo junto a la «complejidad ciclomática».
En una clase o interfaz. No hay un umbral universal. Compara con el resto de clases del proyecto y fíjate en las que se salen mucho de la distribución. Una clase grande con pocas responsabilidades (datos, constantes) es menos grave que una mediana con muchas.
Qué hacer con un valor alto. Extraer métodos, mover responsabilidades a otras clases, o eliminar código repetido. La métrica baja, pero el criterio es el diseño, no el número.
Para profundizar
Esta es la definición de SLOC físico «sin comentarios» que recoge Wikipedia como la más común. La variante lógica
cuenta sentencias; el «número de sentencias» (STAT) se acerca a ella. Robert E. Park y otros
publicaron en 1992 un marco del Software Engineering Institute para declarar qué se cuenta.
SonarQube define ncloc como el número de líneas físicas con al menos un carácter que no es espacio, tabulación ni
parte de un comentario: la misma idea. Medir líneas es sensible al estilo: un equipo que pone la llave de apertura
en línea propia obtiene valores más altos con el mismo código.
Relación con otras métricas
- «Líneas de código» (
LOC): la misma cuenta sin quitar los comentarios.LOC - NCLOCes el número de líneas que solo tienen comentario. - «Líneas de comentario» (
CLOC): las líneas que tienen comentario, también las que comparten línea con código; por esoCLOCno esLOC - NCLOC. - «Ratio real de comentarios» (
TCOM_RAT): divide las líneas que solo tienen comentario entreNCLOC. El «ratio de comentarios» (COM_RAT), en cambio, divideCLOCentreLOC. - «Complejidad ciclomática» (
v(G)): suele crecer con las líneas; se leen juntas. - «Líneas de código sin comentarios (agregadas)»: la suma por paquete, módulo, proyecto y tipo de fichero.
- «Número de sentencias» (
STAT): el tamaño contado en sentencias, que no depende del formato.
En las herramientas
Stau Metro (SourceLinesOfCodeMethod, SourceLinesOfCodeClass, SourceLinesOfCodeInterface).
- Método. Constructores, métodos abstractos y de interfaz incluidos. El Javadoc del método no cuenta. Lo que hay dentro de lambdas y de clases anónimas o locales declaradas en el cuerpo cuenta para el método que las contiene; los métodos de esas clases no tienen valor propio. Sí lo tienen los métodos de una clase anónima declarada en el inicializador de un campo o en el cuerpo de una constante de un enumerado.
- Clase. Clases con nombre (enumerados, records y abstractas incluidos). Las clases anónimas y las locales, y las
clases declaradas dentro de ellas, no tienen valor propio; las interfaces y los tipos de anotación tampoco. Se
restan las líneas de las clases e interfaces anidadas (miembro), y también sus comentarios. Como en
«
LOC», se resta el texto entero de la anidada con su Javadoc, aunque este empiece en una línea con código de la clase exterior. - Interfaz. Las interfaces propiamente dichas, con la misma regla; ni los tipos de anotación ni las interfaces locales entran.
- Una línea con código y comentario cuenta como código; varios comentarios en una línea restan una vez.
SonarQube: ncloc, ver arriba. Checkstyle: MethodLength con countEmpty a false excluye líneas vacías y
comentarios.
Referencias
- Park, R. E. y otros (1992). Software Size Measurement: A Framework for Counting Source Statements. Informe técnico CMU/SEI-92-TR-20, Software Engineering Institute, Carnegie Mellon University.
- 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/
- Checkstyle, comprobación
MethodLength: https://checkstyle.sourceforge.io/checks/sizes/methodlength.html