MATLAB Code Analyzer Report
Run the Code Analyzer Report
The Code Analyzer Report displays potential errors and problems, as well as
opportunities for improvement in your code through messages. For example, a common
message indicates that a variable foo
might be unused.
To run the Code Analyzer Report:
In the Current Folder browser, navigate to the folder that contains the files you want to check.
Click
, and then select Reports > Code Analyzer Report.
The report displays in the MATLAB® Web Browser, showing those files identified as having potential problems or opportunities for improvement.
For each message in the report, review the suggestion and your code. Click the line number to open the file in the Editor at that line, and change the file based on the message. Use the following general advice:
If you are unsure what a message means or what to change in the code, click the link in the message if one appears. If the message does not contain a link, and you are unsure what a message means or what to do, search for related topics in the Help browser. For more information, see Check Code for Errors and Warnings Using the Code Analyzer.
The messages do not provide perfect information about every situation and in some cases, you might not want to change anything based on the message. For more information, see Understand the Limitations of Code Analysis.
If there are certain messages or types of messages you do not want to see, you can suppress them. For more information, see Adjust Code Analyzer Message Indicators and Messages.
After modifying the file, save it. Consider saving the file to a different name if you made significant changes that might introduce errors. Then you can refer to the original file, if needed, to resolve problems with the updated file. Use the
Compare button on the Editor or Live Editor tab to help you identify the changes you made to the file. For more information, see Compare Files and Folders and Merge Files.
Run and debug the file or files again to be sure that you have not introduced any inadvertent errors.
If the report is displaying, click Rerun This Report to update the report based on the changes you made to the file. Ensure that the messages are gone, based on the changes you made to the files. To rerun the report in MATLAB Online™, in the Current Folder browser, click
, and then select Reports > Code Analyzer Report.
Change Code Based on Code Analyzer Messages
For information on how to correct the potential problems presented in Code Analyzer messages, use the following resources:
Open the file in the Editor and click the Details button in the tooltip, as shown in the image following this list. An extended message opens. However, not all messages have extended messages.
Use the Help browser Search pane to find documentation about terms presented in the messages.
The following image shows a tooltip with a Details button.
The orange line under the equals (=
) sign
indicates a tooltip displays if you hover over the equals sign. The orange
highlighting indicates that an automatic fix is
available.
Other Ways to Access Code Analyzer Messages
You can get Code Analyzer messages using any of the following methods. Each provides the same messages, but in a different format:
Access the Code Analyzer Report for a file from the Profiler detail report.
Run the
checkcode
function, which analyzes the specified file and displays messages in the Command Window.Run the
mlintrpt
function, which runscheckcode
and displays the messages in the Web Browser.Use automatic code checking while you work on a file in the Editor. For more information, see Check Code for Errors and Warnings Using the Code Analyzer.