Main Content

Code Quality Dashboard

View code quality metrics for projects

Since R2023a

expand all in page

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 uses:

Open Live Script

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.

Open Live Script

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.

Open Live Script

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
pathLength = 
3

Get the metrics from the Code Quality Dashboard.

metrics = matlabtest.codequalitydashboard.getMetrics
metrics = struct with fields:
    ProjectPath: "C:\Users\jdoe\MATLAB\MATLABShortestPath"
        Metrics: [1×1 struct]

Export the metrics to a JSON file.

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

If you have Requirements Toolbox™, you can open the requirement sets in the current project in the Requirements Editor (Requirements Toolbox).

To open the requirement sets, open the Code Quality Dashboard and click the Requirements section.

If you have loaded requirement sets that are not in the current project, a dialog box prompts you to save and close them. (since R2024b)

The Requirements Editor (Requirements Toolbox) opens and displays the loaded requirement sets.

Since R2024b

If you have Requirements Toolbox, you can generate a traceability matrix that contains the requirement sets and MATLAB tests in the current project.

To generate the traceability matrix, open the Code Quality Dashboard. Then, in the Requirements section, click the three-dot icon and select Generate Traceability Matrix.

If you have loaded requirement sets that are not in the current project, a dialog box prompts you to save and close them.

The Traceability Matrix window opens and displays the loaded requirement sets on the top and the tests on the left.

The Traceability Matrix window shows the requirements and tests for the Shortest Path project.

For more information about traceability matrices, see Track Requirement Links with a Traceability Matrix (Requirements Toolbox).

Version History

Introduced in R2023a

expand all

See Also

Apps

Functions

Topics