Page tree
Skip to end of metadata
Go to start of metadata

Summary: Documentation for the Code Lines extension.

Extension ID

com.castsoftware.codelines

Release Notes

This extension is no longer maintained and is now replaced with Core Metrics.

See Code Lines - 1.0 - Release Notes.

Description

This extension provides an algorithm for generating Line of Code (LOC) counts. The algorithm is an improved and more precise version of the Line of Code count mechanism which is built in to AIP Core. Installing the extension will mean that any Line of Code values reported by AIP (for example in the CAST Dashboards) will use the extension's algorithm and not the mechanism built into AIP Core.

The extension is designed to resolve a recurring issue found when looking at the results of CAST AIP analyses when the built-in Line of Code count mechanism is used: when building user-defined modules (UDM) to group together specific objects, some objects may be filtered/excluded. The Line of Count counts produced for these UDMs can therefore be misleading because the algorithm uses source code LOCs which may include the specific objects that have been filtered/excluded from the UDM. The algorithm provided in this extension uses artifact based LOC counts and is able to distinguish when an object has been excluded from a UDM and will therefore not include it in the LOC count.

It is possible to revert to the default Line of Code count mechanism provided in AIP Core by uninstalling the extension.

Compatibility

ProductReleaseSupported
AIP Core≥ 8.3.16(tick)

Download and installation instructions

What results can you expect?

The Code Lines extension will alter the results produced by the following built-in metrics:

  • #10151: Number of Code Lines
  • #10107: Number of Comment Lines

When compared with LOC counts produced by the mechanism built-in to AIP Core, there is expected to be a +/- 5% difference in values.

  • No labels