Main Content

Code Quality Dashboard

View code quality metrics for projects

Since R2023a

Description

Use the Code Quality Dashboard to view project quality metrics, including code analysis, test and code coverage results, and requirements verification status.

Code Quality Dashboard with metric results for a project.

Open the Code Quality Dashboard App

Open a project, then use one of these approaches to open the app:

  • MATLAB® Toolstrip: In the Project tab, in the Tools menu, under Apps, click Code Quality Dashboard.

  • MATLAB command prompt: Enter codeQualityDashboard.

Examples

expand all

This example shows how to collect test and requirements metric results and reflect the results in the Code Quality Dashboard.

Open the MATLABShortestPath project.

openProject("MATLABShortestPath");

Open the Code Quality Dashboard.

codeQualityDashboard

Run all tests in the project by clicking the Run button run_16.png.

This example shows how to collect coverage metric results and reflect the results in the Code Quality Dashboard.

Open the MATLABShortestPath project.

openProject("MATLABShortestPath");

Open the MATLAB Test Manager.

matlabTestManager

In the toolstrip, click the Code Coverage button coverage_16.png and select Enable Code Coverage, then set the coverage metric level to MC/DC.

Open the Code Quality Dashboard.

codeQualityDashboard

Run tests and collect coverage by clicking the Run button run_16.png.

This example shows how to update, get, and export metrics from the Code Quality Dashboard.

Open the ShortestPath project.

openProject("MATLABShortestPath");

Open the Code Quality Dashboard.

codeQualityDashboard

Run the tests in the project, collect coverage for the tests, verify the requirements, and update the metrics in the dashboard.

matlabtest.codequalitydashboard.runTestsAndRefreshData

Get the metrics from the Code Quality Dashboard.

metrics = matlabtest.codequalitydashboard.getMetrics
metrics = struct with fields:
    ProjectPath: "C:\Users\jdoe\MATLAB\MATLABShortestPath"
     ExportTime: '2023-11-17T15:49:53***'
        Metrics: [1×1 struct]

Export the metrics to a JSON file.

filePath = matlabtest.codequalitydashboard.exportMetrics
filePath = 
"C:\Users\jdoe\MATLAB\MATLABShortestPath\CodeQualityMetrics.json"

Version History

Introduced in R2023a

expand all