Text and HTML Reports

prevnext

Metrics


Three ways to Get Metrics Information

Understand for C++ provides three ways to get metrics information:

n Reports - these are described below. It is important to note that not all metrics collected are reported. Some were left out to save space or because they defied categorization.
n Export - All metrics may be exported from the Project -> Metrics Export menu. Metrics may be chosen. Output is comma delimited, which most spreadsheets and databases support.
n PERL/C API - a more advanced way to get existing metrics, and also to calculate new metrics, is with the PERL and C API. These provide full access to the Understand for C++ database. Examples and documentation can be found at http://www.scitools.com/perl.shtml

What Metrics are Available?

The complete list of all metrics that Understand for C++ has available changes frequently - more frequently than this manual is reprinted.

But a complete and accurate list is always available on our web site:

http://www.scitools.com/metrics.txt

The Function Metrics Report provides information on various metrics for each function.

Metrics provided are: the total number of lines per function, the total number of lines of code in the function, the total number of lines that contain comments, and the total number of blank lines.

Metric Reports

Reports can be generated in HTML and Textual formats. Since these reports are often read by those not having Understand for C++ the metrics are documented in the HTML reports.

Exporting Project Metrics Info

Project metrics can be saved to a comma delimited text file which can be used in Excel and other spreadsheet programs.

From the Project menu, select Metrics Export-> Set Options, and the following dialog appears. Specify the file name for the metrics text file and select whether column titles are to be included in the file or not.

After setting options, choose Project->Metrics Export->Generate, and the file is exported. Following is an excerpt of the comma delimited metrics file produced.

prevnext


Scientific Toolworks, Inc.
http://www.scitools.com
Voice: (802) 763-2995
Fax: (802) 763-3066
support@scitools.com
sales@scitools.com