Skip to content

JavaNCSS : Explain Counting #15080

@rnveach

Description

@rnveach

Expand https://checkstyle.org/checks/metrics/javancss.html#Description to explain what is counted.

The table should be similar to https://checkstyle.org/checks/metrics/npathcomplexity.html#Description .

We can identify what is counted and why by looking at https://github.com/nokia/javancss/blob/90aca669d2dce3937f4f981dece4a77c4453c91c/src/main/javacc/Java1.1.jj

Note: https://github.com/codehaus/javancss looks more like the official repository of this util versioned 34.55, copyrighted 1997 .
The Java 1.5 version in http://www.kclee.de/clemens/java/javancss/javancss-32.53.zip has no counting logic.

There are currently 36 instances of counting in this util.

Example:
https://github.com/nokia/javancss/blob/90aca669d2dce3937f4f981dece4a77c4453c91c/src/main/javacc/Java1.1.jj#L1028
_ncss++; adds a count of 1. We will have to read the jj file to understand context.

As we create the table, we should verify each instance of counting for 2 things:

  1. We are understanding the jj file correctly and verify the count with the tool.
  2. We are duplicating the logic correctly in our own version of the Check and the counts match up.

Usage of using javancss:

> java -jar .\javancss-34.55-SNAPSHOT-all.jar .\Test.java
Java NCSS: 5

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions