Number of Lines Without Comment

Number of lines of code excluding blank lines and comment-only lines

Description

Note

Use Bug Finder instead of Code Prover for computing code metrics. Support for computing code metrics in Code Prover will be removed in a future release. See Version History.

The number of lines without comment is given by

Number of lines without comment  = N_T - (N_B + NC),

where:

N_T is the total number of lines.
N_B is the number of blank lines.
N_C is the number of comment-only lines.

Lines of code that contain inline comments are considered executable lines of code and are excluded from N_C when calculating this metric.

Polyspace^® calculates this metric for source files and header files in the same folders as source files. Use one of these options to specify other behavior:

To report the metric for other header files, change the default value of the option Generate results for sources and (-generate-results-for).
To not report the metric for header files at all, change the value of the option Do not generate results for (-do-not-generate-results-for) to all-headers.

Examples

expand all

Calculate Number of Lines Without Comment

// Function to calculate power
long long power(double x, int n) {
	long long BN = 1;       // long long
	for(int i = 0; i < n; ++i) {
		BN *= x;
	}
	return BN;
}

// Function to calculate approximate index
double AppxIndex(double m, double f) {
	double U = (power(m, 2) - 1) / (power(m, 2) + 2);          //First term
	double V = (power(m, 4) + 27 * power(m, 2) + 38) /
	           (2 * power(m, 2) + 3);                         // Second term
	return (1 + 2 * f * power(U, 2) * (1 + power(m, 2) * U * V +
	                                   power(m, 3) / power(m, 3) * (U - V)))
	       / ((1 - 2 * f * power(U, 2) * (1 + power(m, 2) * U * V
	                                      + power(m, 3) / power(m, 3) * (U - V))));
}

In this example, Polyspace calculates the number of lines without comment by subtracting the number of lines that are comment-only (N_B) and blank lines (N_B) from the total number of lines (N_T) in the source file. Polyspace evaluates the metric as 16. When evaluating this metric, the lines of code that contain inline comments are counted as executable lines of code.

Metric Information

Group: File

Acronym: LINES_WITHOUT_CMT

HIS Metric: No

Version History