scitools.com

← Metric catalog

Comment Lines is one of the source-code metrics Understand computes across 17+ languages — browse them in the GUI, export and track them, or script them with the Python API.

Comment Lines

API ID: CountLineComment
Also Known As: Comment Lines of Code (CLOC)
Languages: Ada, Assembly, Basic, C#, C++, Fortran, Java, Jovial, Pascal, Python, Rust, VHDL, Web
Targets: Architectures, Classes, Files, Functions, Modules, Packages, Project, Subprograms

Number of lines containing a comment.

A line only counts if it is active. This can overlap with other code counting metrics — for instance int j = 1; // comment has a comment, is a source line, is an executable source line, and is a declarative source line.

For example:

void SayHello::printHello() {
  switch (i) {
    case 0:
      cout << "Hello World" << endl;
    case 1:
      cout << "HELLO WORLD!" << endl;
    default: // a comment here
      for (int m = 0; m < j; m++);
      cout << "hello world" << endl;
  }
#ifdef A_VERY_NICE_VARIABLE

  cout << "Inactive Line" << endl; // Inactive
#endif

}

The default: // a comment here line (17) is the only active comment line. The // Inactive comment on the cout line inside the #ifdef block doesn't count because that line is inactive, giving CountLineComment = 1.

To also count comments inside inactive regions, use Comment Lines (Includes Inactive). For the per-language breakdown in web files, see Comment Lines (HTML), Comment Lines (JavaScript), and Comment Lines (PHP).

Also known as Comment Lines of Code (CLOC).


Targets By Language: Configuration: