Reporting Code Diff

XClarify Documentation

  • Docs
  • Reporting Code Diff

Reporting Code Diff
This document explains how to use the XClarify build comparison features, in the context of reporting.
The document Advanced Code Diff from within XClarify explains how to use the XClarify build comparison features, in the context of the interactive UI.

XClarify can report Code Diff in the report. To report Code Diff, there are two steps.

  • First, define the baseline for comparison
  • Second, define the CQLinq queries and rules related to Code Diff
To define the Baseline, go into the XClarify Project Properties panel in the interactive UI. In the Analysis tab of this panel, there is an option named Baseline for Comparison. The Baseline for Comparison represents the previous code base snapshot. The current code base snapshot will be compared to this previous code base snapshot.

Two different Baselines for Comparison can be defined: one to be used in the interactive UI, one to be used at analysis and reporting time. It is recommended to define the same Baseline for Comparison for both interactive UI and reporting scenarios.



After having defined the Baseline for Comparison, have a look at the standard CQLinq groups named:

  • Code Quality Regression
  • API Breaking Changed
  • Code Diff Summary
Here, many CQLinq queries and rules related to code diff are already defined. You can use them straight, or customize them to your needs.



Notice that it is also possible to report only code rules violations that occur on code elements added or refactored since the baseline for comparison. This is explained here

Go to top