Main Content

MATLAB 代码分析器报告

打开代码分析器报告

代码分析器报告通过消息显示代码中的潜在错误和问题以及改进机会。使用代码分析器以交互方式浏览报告,该 App 可通过以下方式打开。

  • MATLAB® 工具条:在 App 选项卡上的 MATLAB 下,点击该 App 图标:Code Analyzer App Icon

  • MATLAB 命令提示符:输入 codeAnalyzer

此处 Index of Code Analyzer Checks 提供了 MATLAB 代码分析器执行的所有检查的列表。

运行代码分析器报告

使用代码分析器分析指定文件或文件夹中的代码。

  1. 对所需的文件或文件夹运行代码分析器

    codeAnalyzer("C:\MyCode") 

    此命令启动代码分析器,针对指定的代码就发现的问题生成报告。报告顶部的摘要部分概述报告中包含的信息。此部分显示分析了多少个文件,以及在分析的代码中发现的错误、警告和信息性消息的总数。

    Code Analyzer app showing an overall summary of code issues and code health details

  2. 默认情况下,问题按严重性分组。您可以使用分组依据列表来更改问题的分组方式。按文件对报告进行分组。

    Code Analyzer report grouped by file.

  3. 您可以使用按严重性过滤按问题类型过滤列表来过滤显示的消息。过滤报告以仅显示错误。

    Code Analyzer report filtered by severity

  4. 有些问题可以通过自动替换来解决。这些问题提供有全部修复按钮。如果您通过点击来展开问题,则可以通过点击对应的修复按钮来修复问题的单个实例。将光标悬停在修复全部修复按钮上可查看 MATLAB 将实现的修复。

    Code Analyzer report with fixable issues.

根据代码分析器消息更改代码

要了解有关如何更正代码分析器消息中指出的潜在问题的信息,请使用以下资源:

  • 在编辑器中打开文件,并点击工具提示中的详细信息按钮,如本列表随后的图像所示。此时将打开扩充的消息。但是,并非所有消息都具有扩充的消息。

  • 使用帮助浏览器的搜索窗格可查找有关消息中提到的术语的文档。

下图显示了带详细信息按钮的工具提示。等号 (=) 下边的橙色线条指明当您将鼠标指针悬停于等号上时会显示工具提示。橙色的高亮显示方式指示可以使用自动修复。

在 R2023a 中: 具有自动修复功能的问题可以通过对 codeIssues 对象使用 fix 函数以编程方式进行修复。这些问题也可以使用代码分析器以交互方式修复。

访问代码分析器消息的其他方法

使用下列任一方法均可获取代码分析器消息。每种方法都提供相同的消息,但采用的格式不同:

配置代码分析器消息

自 R2023a 起

您可以配置代码分析器显示的现有检查项,并通过将名为 codeAnalyzerConfiguration.json 的文件放在一个 resources 文件夹中来添加自定义检查项。此文件配置对 resources 文件夹的父文件夹及其子文件夹执行的代码分析器检查。

有关详细信息,请参阅Configure Code Analyzer

另请参阅

| |

相关主题