本页翻译不是最新的。点击此处可查看最新英文版本。

使用安装程序安装 Polyspace as You Code

当您使用代码编辑器或以下受支持的 IDE 时，Polyspace® as You Code 可检查您的代码是否存在 Bug 和编码标准违规。

  • Visual Studio® 2019（版本 16.11.* 及更高版本）和 2022（版本 17.2.* 及更高版本）

  • Visual Studio Code（版本 1.62 至 1.79）1, 2

  • Eclipse™（版本 2019-09 至 2022-12）3 和基于 Eclipse 的 IDE，例如 Code Composer Studio、HighTech 或 Windriver Workbench。

注意

在 Visual Studio 中安装 Polyspace as You Code 扩展之前，请先卸载任何先前版本的扩展。

Polyspace as You Code 使用 Polyspace Access™ 网络指定用户 (NNU) 许可证，并且需要使用许可证管理器来管理许可证签出。

准备 Polyspace as You Code 安装

Polyspace Access 安装镜像中提供了 Polyspace as You Code 安装程序。

典型的安装过程为：

  1. 管理员下载 Polyspace Access，在服务器计算机上安装许可证管理器，然后配置 Polyspace Access 许可证。

    1. 要下载 Polyspace Access 安装镜像，请转至 MathWorks® 下载页面，展开 Get Polyspace Access 部分并点击下载。

      要完成此步骤，您可能需要登录到您的 MathWorks 帐户。

    2. Polyspace Access 安装提供了许可证管理器。您还可以通过许可证管理器下载页面来下载许可证管理器。

      要配置 Polyspace Access 许可证，请参阅配置 Polyspace Access 许可证。

      请向最终用户提供您在步骤 3：配置客户端许可证中配置的客户端许可证文件的路径。此许可证通常名为 network.lic 并包含以下行：

      SERVER lmHostname HostID 27000
USE_SERVER
      其中，lmHostname 是安装许可证管理器的计算机的主机名。HostID 是您提供的用于激活 Polyspace Access 许可证的 MAC 地址。

  2. 管理员或最终用户在与许可证管理器服务器计算机位于同一网络中的客户端计算机上安装 Polyspace as You Code。

    提示

    Polyspace as You Code 使用本地服务器在分析引擎与 IDE 扩展之间进行通信。如果使用代理服务器，请将系统配置为使 localhost 不使用代理。例如，在 Linux 上，请设置环境变量 export no_proxy=localhost。

    下表介绍了在开始安装前需要执行的其他步骤，具体取决于您的角色和安装类型。

    安装类型角色步骤
    从 Polyspace Access 界面下载安装程序并以交互方式进行安装管理员

    1. 安装并启动 Polyspace Access。请参阅安装用于 Web 审查的 Polyspace Access。

    2. 向最终用户提供 Polyspace Access URL 和许可证文件的路径。

    最终用户

    1. 从管理员处获取许可证文件的路径和 Polyspace Access URL。

    2. 下载并解压缩 Polyspace as You Code 安装文件夹。登录到 Polyspace Access 界面并点击help button > 下载 Polyspace as You Code。

    3. 请参阅以交互方式安装 Polyspace as You Code来进行安装。如果您安装 Visual Studio Code 或 Eclipse IDE 扩展，则必须提供 IDE 的安装路径。

    从共享位置启动安装程序并以交互方式进行安装管理员

    1. 安装并启动 Polyspace Access。请参阅安装用于 Web 审查的 Polyspace Access。

    2. 下载并解压缩 Polyspace as You Code 安装文件夹。登录到 Polyspace Access 界面并点击help button > 下载 Polyspace as You Code。

    3. 向最终用户提供您在步骤 a 中解压缩的安装文件夹的路径，以及许可证文件的路径。

    最终用户

    1. 从管理员处获取许可证文件的路径和安装程序的位置。

    2. 请参阅以交互方式安装 Polyspace as You Code来进行安装。如果您安装 Visual Studio Code 或 Eclipse IDE 扩展，则必须提供 IDE 的安装路径。

    以非交互方式进行安装管理员或最终用户

    1. 获取许可证文件的路径和安装程序的位置。

    2. 修改安装程序属性文件：

      • 提供 Polyspace as You Code 安装文件夹的路径。

      • 决定是否要安装 IDE 扩展。对于 Visual Studio Code 和 Eclipse IDE，您必须提供 IDE 的安装路径。

        请参阅以非交互方式安装 Polyspace as You Code。

    注意

    要在不安装和启动 Polyspace Access 的情况下获取 Polyspace as You Code 安装程序，请联系您的 MathWorks 销售代表。

用于基于 Eclipse 的 IDE 的 Polyspace as You Code 插件与用于 Eclipse 的 Polyspace 桌面端插件不兼容。如果您使用安装程序安装 Polyspace as You Code Eclipse 插件，Polyspace 将卸载桌面端插件。

以交互方式安装 Polyspace as You Code

前提条件：请参阅准备 Polyspace as You Code 安装。

要以交互方式安装 Polyspace as You Code，请在命令行中导航到包含 Polyspace as You Code 安装程序的文件夹，并根据您的操作系统输入下表中列出的命令。

Windows®

setup.exe

还可以通过双击 setup.exe 二进制文件来启动安装程序。

Linux®./install.sh

注意

如果您在 Linux 上安装 Polyspace as You Code Eclipse 插件，请参阅在 Linux 上为受支持的 Java 版本配置 Eclipse。

Polyspace as You Code installer interface

在 Polyspace as You Code 安装向导中，点击下一步并按照提示完成安装。

  • 如果没有可用的许可证文件，则可以跳过许可证选择步骤，并在稍后提供许可证。

    从 Polyspace 管理员处获取 network.lic 许可证文件后，将该文件复制到位于 Polyspace as You Code 安装文件夹中的 licenses 文件夹，即可完成安装。例如，/usr/local/PolyspaceAsYouCode/R2024a/licenses。

  • 如果安装 IDE 扩展：

    • 安装程序可能需要花费一些时间，然后您才能继续执行下一个安装步骤。

    • 开始使用 Polyspace as You Code 之前，您必须完成扩展配置。请参阅Polyspace as You Code IDE 扩展设置。

以交互方式卸载 Polyspace as You Code

  1. 转至 Polyspace as You Code 安装文件夹中的 Uninstall 文件夹（例如 C:\Program Files\Polyspace as You Code\R2024a\Uninstall）。

  2. 启动 Uninstall.exe 二进制文件 (Windows) 或 Uninstall 脚本 (Linux)。

此操作将卸载 Polyspace as You Code 和 IDE 扩展。

以非交互方式安装 Polyspace as You Code

前提条件

- 请参阅准备 Polyspace as You Code 安装。

以非交互方式进行安装时，您可以执行以下操作之一：

  • 使用指定安装配置的属性文件启动安装程序。

  • 使用 -silent 选项启动安装程序，以仅安装 Polyspace as You Code 分析引擎。

使用安装程序属性文件安装 Polyspace as You Code

要在一个属性文件中指定您的安装配置并以非交互方式安装 Polyspace as You Code，请执行以下操作：

  1. 编辑安装程序属性文件。installerRoot/Docs/installer.properties 中有一个安装程序属性文件模板，其中 installerRoot 是包含 Polyspace as You Code 安装程序的文件夹。

  2. 在命令行中，导航到包含 Polyspace as You Code 安装程序的文件夹。根据您的操作系统，输入下表中列出的命令之一。

    Windows

    setup.exe -f installerPropertiesFile

    Linux./install.sh -f installerPropertiesFile

    installerPropertiesFile 是安装程序属性文件的完整路径。

例如，要使用许可证文件 C:\Polyspace\licenses\network.lic 在文件夹 C:\Program Files\Polyspace as You Code\R2024a 中安装 Polyspace as You Code，请指定以下安装程序属性文件。 INSTALL_VS_PLUGIN=true 行支持安装 Visual Studio 扩展。

# Installer properties file
# Uncomment the line below to launch the installer in silent mode.
INSTALLER_UI=silent

# Uncomment the line below and specify an installation folder path or
# leave line commented to install in default installation folder.
# Enter '\' characters in the folder path as '\\', for instance:
# C:\\Program Files\\Polyspace as You Code\\R2024a
USER_INSTALL_DIR=C:\\Program Files\\Polyspace as You Code\\R2024a

##### Begin - Windows only options #####
# Set to true to install the Visual Studio extension.
INSTALL_VS_PLUGIN=true
##### End   - Windows only options #####

# Set to true to install the Visual Studio Code extension.
INSTALL_VSCODE_PLUGIN=false
# If INSTALL_VSCODE_PLUGIN is set to "true", provide the path to the 
# Visual Studio Code installation folder, for instance /usr/share/code
VSCODE_INSTALL_FOLDER=

# Set to true to install the Eclipse extension.
INSTALL_ECLIPSE_PLUGIN=false
# If INSTALL_ECLIPSE_PLUGIN is set to "true", provide the path to the 
# Eclipse executable
ECLIPSE_EXECUTABLE_PATH=

# Provide the path to the license file. The file will be copied to <install_root>/licenses.
LICENSE_FILE=C:\\Polyspace\\licenses\\network.lic

# Keep true to improve Polyspace by sending user experience information to MathWorks.
# Set to false to not send information to MathWorks.
# See details here: https://www.mathworks.com/support/faq/user_experience_information_faq.html
SEND_UX_INFO_TO_MW=true

注意

如果您在 Linux 上安装 Polyspace as You Code Eclipse 插件，请参阅在 Linux 上为受支持的 Java 版本配置 Eclipse。

仅安装 Polyspace as You Code 分析引擎

要在不打开图形界面的情况下仅安装 Polyspace as You Code 分析引擎，请使用 -silent 标志启动安装程序二进制文件。安装程序会根据您的操作系统将 Polyspace as You Code 安装到以下默认位置：

Windows C:\Program Files\Polyspace as You Code\R2024a
Linux/usr/local/PolyspaceAsYouCode/R2024a
macOS/Applications/PolyspaceAsYouCodeR2024a

要指定不同的安装路径，请使用 -install-dir 标志，例如 ./install.sh -silent -install-dir /local/myFolder。

将 Polyspace Access network.lic 许可证文件复制到位于 Polyspace as You Code 安装文件夹中的 licenses 文件夹，即可完成安装。例如，/usr/local/PolyspaceAsYouCode/R2024a/licenses。

以非交互方式卸载 Polyspace as You Code

要在不打开图形界面的情况下卸载 Polyspace as You Code，请执行以下操作：

  1. 转至 Polyspace as You Code 安装文件夹中的 Uninstall 文件夹（例如 C:\Program Files\Polyspace as You Code\R2024a\Uninstall）。

  2. 使用 -i silent 标志启动 Uninstall.exe 二进制文件 (Windows) 或 Uninstall 脚本（Linux 或 macOS）。

卸载操作将删除 Polyspace as You Code 和 IDE 扩展。

另请参阅

主题

1 It is likely that Polyspace as You Code will run successfully with a later version, however, there might be certain issues.

2 If your version of Visual Studio Code uses the Workspace Trust feature, the Polyspace as You Code extension is disabled when you open a folder in Restricted Mode. To enable the extension, mark the folder as trusted. See Workspace Trust.

3 If you install the Polyspace as You Code Eclipse plugin on Linux, see 在 Linux 上为受支持的 Java 版本配置 Eclipse.