Skip to content

Commit

Permalink
Add documentation for suspicious metrics feature #2963.
Browse files Browse the repository at this point in the history
  • Loading branch information
ce-bo committed Jan 16, 2023
1 parent 46f6f47 commit 96c3e13
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions gh-pages/_docs/06-05-suspicious-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,17 @@
permalink: /docs/suspicious-metrics/
title: "Suspicious metrics"

This feature compares the values of certain metrics from the loaded cc.json file with metric values of 241Open Source Java projects.
Based on this data suspicious and inconspicuous metrics are identified and corresponding suggestions can be clicked to view them.
The Suspicious Metrics feature button appears in the main menu. Pressing this button will open the suspicious metrics panel.
Compare [User Controls Legend]({{site.baseurl}}{% link _docs/06-02-user-controls.md %}).
This feature will find the suspicious metrics in a code base and provides options that can be clicking to highlight high-risk files directly in the map that probably have a limited maintainability.

Be aware that metrics for other programming languages might not be comparable to Java Reference metric values.
It compares the values of certain metrics from the loaded cc.json file with metric values of 241 Open Source Java projects.
Based on this data suspicious, inconspicuous and untracked metrics are identified and corresponding suggestions can be clicked (see following Screenshot) to automatically view them in the map.

![Suspicious Metrics]({{site.baseurl}}/assets/images/docs/how-to/generate_user_token.PNG)

The Suspicious button appears in the main menu. Pressing this button will open the suspicious metrics panel.
Listed you will find the suspicious metrics, clicking one of them highlights high-risk files directly on the map.
The suspicious metrics in the shown screenshot provide buttons for three metrics to be clicked for visualizing affected code files.
The small warning icon button can also be clicked. It expresses that there are some files that are considered as outliers in terms of statistically significant high metric values

Be aware that metrics for other programming languages might not be comparable to Java Reference metric values.
Though, it can give you a feeling about the code quality in code bases composed with other programming languages.

0 comments on commit 96c3e13

Please sign in to comment.