主要内容

Visual Studio 中为 Polyspace as You Code 配置检查项

您可以在 Visual Studio® 中使用 Polyspace® as You Code 来检查各种类型的缺陷和编码违规。默认分析会检查默认 Polyspace Bug Finder™ 缺陷。若要检查其他缺陷和编码违规,请配置 Polyspace as You Code 扩展。

若要配置检查项,您可以重用现有检查项文件。您也可以直接从您的 IDE 创建检查项文件。有关 Polyspace 桌面端和服务器端中的等效工作流,请参阅Prepare Checkers Configuration for Polyspace Bug Finder Analysis (Polyspace Bug Finder)

根据您可用的资源或工件,使用以下方法之一在您的 IDE 扩展中配置检查项。

使用现有检查项激活文件

您可以使用检查项激活文件 (XML) 或用户定义的编码标准 (.pschk) 来配置检查项。检查项激活文件用于激活一组 Bug Finder 缺陷和外部编码规则。利用用户定义的编码标准,您可以在现有编码标准无法完全满足您的需求时,将与您的工程特别相关的编码规则收集到单个标准中。如果您有这些工件中的任一工件,请在选项窗口中指定该工件的路径:

  1. 配置视图中点击 Settings,以打开选项窗口。

  2. 分析设置视图的检查项文件设置中,输入检查项激活文件的完整路径或自定义编码标准。

您也可以修改检查项选择。在配置视图中,点击配置检查项图标 (checkers settings),以打开检查项选择窗口。修改检查项选择,然后保存更改。点击完成,以关闭窗口。

从工程导入检查项配置

如果您有 Polyspace 桌面端工程文件 (.psprj),则可以从中导入检查项配置。在命令行中输入:

ps-migrate-checkers-selection -import-options-from-psprj PathToProject

  • ps-migrate-checkers-selection 命令位于 polyspaceroot\polyspace\bin\arch 文件夹中。polyspaceroot 是您的开发环境中 Polyspace 安装文件夹所在的位置,并且 archwin64glnxa64maci64 中的一项。

  • PathToProject 是 Polyspace 桌面端工程的完整路径。

您运行该命令之后,Polyspace 会使用导入的检查项配置创建检查项激活文件。检查项激活文件存储在名为 import 的子文件夹中,位置与 .psprj 文件相同。在选项窗口的检查项文件中指定此文件。

您也可以通过在 Polyspace 平台用户界面中打开 .psprj 文件,将 .psprj 工程文件导入为 .psprjx 工程文件。Polyspace 会使用 .psprj 文件的检查项配置来创建检查项激活文件。若要获取您的检查项激活文件的路径,请转到配置,然后选择静态分析选项卡。该路径在缺陷和编码标准 > 检查项激活文件之下。在检查项文件设置中指定该检查项激活文件的路径。

有关更多详细信息,请参阅Generate Build Options for Polyspace as You Code Analysis in Visual Studio

创建检查项配置

如果您没有检查项激活文件 (XML),可以通过使用“检查项选择”窗口创建该文件。不支持从“检查项选择”窗口创建用户定义的编码标准 (.pschk)。有关如何创建用户定义的编码标准的详细信息,请参阅Create User-Defined Coding Standard by Using Polyspace Bug Finder Checkers (Polyspace Bug Finder)

  1. 若要打开“检查项选择”窗口,请在配置视图中选择配置检查项图标 (checkers settings)。

    Polyspace Checkers selection interface

  2. 在“检查项选择”窗口中,选择要激活的检查项。您还可以激活预定义类别的缺陷检查项,例如全部默认。请参阅按影响进行的缺陷分类 (Polyspace Bug Finder)。同样,您可以激活由相应标准定义的一组预定义编码规则。

    • 选择规范 > 软件复杂性检查项时,请审查它们的阈值。如果默认阈值不可接受,请在阈值列中指定一个合适的阈值。请参阅检查规范 (-guidelines) (Polyspace Bug Finder)

    • 选择自定义规则时,请审查规则的模式约定。请参阅检查自定义规则 (-custom-rules) (Polyspace Bug Finder)

    • 若要使用您自己的分类标记对 Bug Finder 缺陷或编码规则检查项进行分类,请在“检查项选择”窗口的注释列中输入文本。当您在 Polyspace Access™ 桌面端界面或 Polyspace as You Code 插件中审查结果时,Polyspace 将在结果详细信息窗格和结果列表详细信息列(如果可用)中显示该文本。

      注意

      以下各项中会省略您在“检查项选择”窗口中输入的自定义文本:

      • 生成的报告。

      • 打开来自 Polyspace Access 的结果时的 Polyspace 桌面端界面。此限制仅适用于 Bug Finder 检查项。

  3. 点击保存更改,将选择另存为可重用的检查项 XML 文件。点击完成,以关闭窗口。

之后您可以重用该检查项 XML 文件作为检查项文件字段中的输入。

修改检查项行为

要修改 Bug Finder 缺陷和编码规则检查项的默认行为,可使用分析选项。有关用于修改检查项默认行为的分析选项的列表,请参阅Modify Default Behavior of Bug Finder Checkers (Polyspace Bug Finder)

若要在 Polyspace as You Code 中为检查项指定分析选项,请执行以下操作:

  • 将分析选项附加到其他分析选项文件字段中指定的选项文件中。该设置位于“选项”窗口的分析设置部分。指定每行包含一个分析选项的文本文件的路径。例如,若要添加分析选项 -code-behavior-specifications (Polyspace Bug Finder)有效布尔类型 (-boolean-types) (Polyspace Bug Finder),请在选项文件中附加以下行:

    -code-behavior-specifications file1
    -boolean-types boolean1_t,boolean2_t
    其中 file1 是代码行为设定文件 (XML),并且 boolean1_t,boolean2_t 是布尔类型。

  • 如果您没有选项文件,请创建一个包含必要选项的选项文件。在其他分析选项文件字段中指定该新选项文件的路径。请参阅用于 Polyspace 分析的选项文件 (Polyspace Bug Finder)

另请参阅

主题