PhpStorm 2025.2 Help

质量工具

PHP_CodeSniffer

在本节中,启用并配置 PHP_CodeSniffer 质量工具。

项目

描述

配置

从列表中选择所需的解释器。 该列表包含所有当前配置的本地和远程 PHP 解释器。 如需更多信息,请参阅 配置本地 PHP 解释器配置远程 PHP 解释器

单击下拉列表右侧的 “浏览”按钮 打开 PHP_CodeSniffer 对话框

显示忽略的文件

单击以打开 PHP_CodeSniffer 忽略的文件 对话框,其中列出了 PHP_CodeSniffer 跳过的文件。 PhpStorm 建议在检查期间,当等待 PHP_CodeSniffer 的响应超过 工具进程超时 字段中指定的限制时,将新文件添加到列表中。 这样做是为了防止处理速度变慢。 对于每个文件,PhpStorm 会显示其名称和位置。

  • 要添加文件,请单击 "添加"按钮 并在打开的对话框中找到所需的文件。

  • 要从列表中删除文件并让 PHP_CodeSniffer 再次处理它,请选择该文件并单击 移除文件 按钮 "移除"按钮

  • 要从列表中删除所有文件,请单击 关闭按钮

检查带扩展名的文件

提供一个以逗号分隔的文件扩展名列表,这些扩展名应由 PHP_CodeSniffer 检查。

将警告显示为...

要让 PHP_CodeSniffer 除了报告错误外还报告警告,请选中复选框并从列表中选择 严重程度。 清除复选框以仅报告错误并抑制警告报告。

显示sniff 名称

选中复选框以在编辑器或 检查结果 中显示相应的 sniff 名称,以及检查摘要。

已安装的标准路径

如果您依赖于自定义的第三方编码标准(例如, CoderJoomla Coding Standards ),则需要在使用 PHP_CodeSniffer 之前将其集成。 为此,请选中 已安装的标准路径 复选框,单击 “浏览”按钮 并在打开的对话框中选择自定义标准的安装目录。

编码标准

指定要应用的编码标准。

  • 要使用预定义的 编码标准 ,请在 编码标准 列表中选择它,并指定要检查代码的编码样式。 列表包含安装在主 php_codesniffer 目录结构中的所有编码标准。

  • 要根据 您自己先前定义的编码标准 检查代码,请从列表中选择 自定义 ,并提供包含您自己编码标准的 ruleset.xml 文件的路径。 手动输入路径或单击 “浏览”按钮 并在打开的对话框中选择相关文件夹。

PHP_CodeSniffer 对话框

单击 “浏览”按钮 ,打开 配置 列表旁边的 PHP_CodeSniffer 页面上的对话框。

使用此对话框配置所用的 PHP 解释器、PHP_CodeSniffer 可执行文件的路径以及 PHP_CodeSniffer 的行为。 有关更多信息,请参见 PHP_CodeSniffer

项目

描述

解释器窗格

对话框的左侧窗格显示用于 PHP_CodeSniffer 的默认 PHP 解释器。 要添加不同的解释器,请单击 "添加"按钮 并从项目中配置的 CLI 解释器 列表中选择一个项目。

PHP_CodeSniffer 路径

在此字段中,指定 PHP_CodeSniffer 脚本的位置:Windows 使用 phpcs.bat ,Linux 和 macOS 使用 phpcs

PhpStorm 会检测 vendor/bin 文件夹中 PHP_CodeSniffer 可执行文件的路径,并自动填写字段,但您可以根据需要进行编辑。 请手动输入路径或点击 “浏览”按钮 并在打开的对话框中选择路径。

要检查指定的 phpcs.bat phpcs 路径是否确保 PhpStorm 与 PHP_CodeSniffer 之间的交互,即工具可以从 PhpStorm 启动并且 PhpStorm 会接收其问题报告,请单击 验证 按钮。 此验证等同于运行 phpcs --version 命令。 如果验证成功,PhpStorm 会显示检测到的 PHP_CodeSniffer 版本信息。

工具进程超时

在此字段中,指定您希望 PhpStorm 等待 PHP_CodeSniffer 返回结果的时间。 如果超时,进程将被终止以防止过多的 CPU 和内存使用。 这使您可以根据计算机的配置和使用的规则集微调 PHP_CodeSniffer 的处理行为。

PHP Code Beautifier and Fixer 设置

在此区域中,在 phpcbf 的路径 字段中提供 PHP Code Beautifier and Fixer 工具的自定义路径。 请手动输入路径或点击 “浏览”按钮 并在打开的对话框中选择路径。

PHP Code Beautifier and Fixer 允许您自动修复 PHP_CodeSniffer 检测到的许多错误。

PHP CS Fixer

在本节中,启用并配置 PHP CS Fixer 质量工具。

项目

描述

配置

从列表中选择所需的解释器。 该列表包含所有当前配置的本地和远程 PHP 解释器。 如需更多信息,请参阅 配置本地 PHP 解释器配置远程 PHP 解释器

单击下拉列表右侧的 “浏览”按钮 打开 PHP CS Fixer 对话框

显示忽略的文件

单击以打开 PHP CS Fixer 忽略的文件 对话框,其中列出了 PHP CS Fixer 跳过的文件。 PhpStorm 建议在检查期间,当等待 PHP CS Fixer 的响应超过 工具进程超时 字段中指定的限制时,将新文件添加到列表中。 这样做是为了防止处理速度变慢。 对于每个文件,PhpStorm 会显示其名称和位置。

  • 要添加文件,请单击 "添加"按钮 并在打开的对话框中找到所需的文件。

  • 要从列表中删除文件并让 PHP CS Fixer 再次处理它,请选择该文件并单击 移除文件 按钮 "移除"按钮

  • 要从列表中删除所有文件,请单击 关闭按钮

允许为内置规则集设置有风险的规则

选中复选框以允许 高风险规则 ,即可能更改代码行为的规则。 默认情况下,不允许高风险规则。

规则集

指定要应用的规则集。

  • 要使用预定义的 规则集 ,请从下拉列表中选择它。 列表包含声明在主 php-cs-fixer 目录结构中的所有规则集。

  • 要根据 您自己先前定义的规则集 检查代码,请从列表中选择 自定义 ,并提供包含此规则集的 .php_cs .php_cs.dist 文件的路径。 手动输入路径或单击 “浏览”按钮 并在打开的对话框中选择相关文件夹。

PHP CS Fixer 对话框

单击 “浏览”按钮 ,打开 配置 列表旁边的 PHP CS Fixer 页面上的对话框。

使用此对话框配置所用的 PHP 解释器、PHP CS Fixer 可执行文件的路径以及 PHP CS Fixer 的行为。 有关更多信息,请参见 PHP CS Fixer

项目

描述

解释器窗格

对话框的左侧窗格显示用于 PHP CS Fixer 的默认 PHP 解释器。 要添加不同的解释器,请单击 "添加"按钮 并从项目中配置的 CLI 解释器 列表中选择一个项目。

PHP CS Fixer 路径

在此字段中,指定 PHP CS Fixer 脚本的位置:Windows 使用 php-cs-fixer.bat ,Linux 和 macOS 使用 php-cs-fixer

PhpStorm 会检测 vendor/bin 文件夹中 PHP CS Fixer 可执行文件的路径,并自动填写字段,但您可以根据需要进行编辑。 请手动输入路径或点击 “浏览”按钮 并在打开的对话框中选择路径。

要检查指定的 php-cs-fixer.bat php-cs-fixer 路径是否确保 PhpStorm 与 PHP CS Fixer 之间的交互,即工具可以从 PhpStorm 启动并且 PhpStorm 会接收其问题报告,请单击 验证 按钮。 此验证等同于运行 php-cs-fixer --version 命令。 如果验证成功,PhpStorm 会显示检测到的 PHP CS Fixer 版本信息。

工具进程超时

在此字段中,指定您希望 PhpStorm 等待 PHP CS Fixer 返回结果的时间。 如果超时,进程将被终止以防止过多的 CPU 和内存使用。 这使您可以根据计算机的配置和使用的规则集微调 PHP CS Fixer 的处理行为。

Laravel Pint

在本节中,启用并配置 Laravel Pint 质量工具。

项目

描述

配置

从列表中选择所需的解释器。 该列表包含所有当前配置的本地和远程 PHP 解释器。 如需更多信息,请参阅 配置本地 PHP 解释器配置远程 PHP 解释器

单击下拉列表右侧的 “浏览”按钮 打开 Laravel Pint 对话框

显示被忽略的文件

单击以打开 Laravel Pint 忽略的文件 对话框,其中列出了 Laravel Pint 跳过的文件。 PhpStorm 建议在检查期间,当等待 Laravel Pint 的响应超过 工具进程超时 字段中指定的限制时,将新文件添加到列表中。 这样做是为了防止处理速度变慢。 对于每个文件,PhpStorm 会显示其名称和位置。

  • 要添加文件,请单击 "添加"按钮 并在打开的对话框中找到所需的文件。

  • 要从列表中删除文件并让 Laravel Pint 再次处理它,请选择该文件并单击 移除文件 按钮 "移除"按钮

  • 要从列表中删除所有文件,请单击 关闭按钮

仅重新格式化未提交的文件

选中复选框以仅修改具有未提交更改的文件。

pint.json 的路径

指定您自己的 pint.json 配置文件的路径。 pint.json 文件是可选的:它们用于启用/禁用预定义 Laravel Pint 预设中的特定规则,或重用来自 PHP CS Fixer 的自定义规则集。

规则集

选择 Laravel Pint 的一个 预定义规则组

Laravel Pint 对话框

单击 “浏览”按钮 ,打开 配置 列表旁边的 Laravel Pint 页面上的对话框。

使用此对话框配置所用的 PHP 解释器、Laravel Pint 可执行文件的路径以及 Laravel Pint 的行为。 有关更多信息,请参见 Laravel Pint

项目

描述

解释器窗格

对话框的左侧窗格显示用于 Laravel Pint 的默认 PHP 解释器。 要添加不同的解释器,请单击 "添加"按钮 并从项目中配置的 CLI 解释器 列表中选择一个项目。

Laravel Pint 路径

在此字段中,指定 Laravel Pint 脚本的位置:Windows 使用 pint.bat ,Linux 和 macOS 使用 pint

PhpStorm 会检测 vendor/bin 文件夹中 Laravel Pint 可执行文件的路径,并自动填写字段,但您可以根据需要进行编辑。 请手动输入路径或点击 “浏览”按钮 并在打开的对话框中选择路径。

要检查指定的 pint.bat pint 路径是否确保 PhpStorm 与 Laravel Pint 之间的交互,即工具可以从 PhpStorm 启动并且 PhpStorm 会接收其问题报告,请单击 验证 按钮。 如果验证成功,PhpStorm 会显示检测到的 Laravel Pint 版本信息。

工具进程超时

在此字段中,指定您希望 PhpStorm 等待 Laravel Pint 返回结果的时间。 如果超时,进程将被终止以防止过多的 CPU 和内存使用。 这使您可以根据计算机的配置和使用的规则集微调 Laravel Pint 的处理行为。

PHP Mess Detector

在本节中,启用并配置 Mess Detector 质量工具。

项目

描述

配置

从列表中选择所需的解释器。 该列表包含所有当前配置的本地和远程 PHP 解释器。 如需更多信息,请参阅 配置本地 PHP 解释器配置远程 PHP 解释器

单击下拉列表右侧的 “浏览”按钮 打开 Mess Detector 对话框

显示忽略的文件

单击以打开 Mess Detector 忽略的文件 对话框,其中列出了 Mess Detector 跳过的文件。 PhpStorm 建议在检查期间,当等待 Mess Detector 的响应超过 工具进程超时 字段中指定的限制时,将新文件添加到列表中。 这样做是为了防止处理速度变慢。 对于每个文件,PhpStorm 会显示其名称和位置。

  • 要添加文件,请单击 "添加"按钮 并在打开的对话框中找到所需的文件。

  • 要从列表中删除文件并让 Mess Detector 再次处理它,请选择该文件并单击 移除文件 按钮 "移除"按钮

  • 要从列表中删除所有文件,请单击 关闭按钮

选项

  • 要使用 预定义规则 ,请在 选项 区域中选中要执行的验证旁边的复选框。

  • 要使用自定义规则集:

    1. 创建并保存一个或多个 规则集文件。 有效的 规则集文件 是一个包含 <ruleset> 根元素和 name 属性的 .xml 文件。 有关 自定义规则集 的更多信息,请参阅 http://phpmd.org/documentation/creating-a-ruleset.html

    2. 自定义规则集 区域中,单击 添加按钮 并在打开的对话框中选择相关规则定义文件。 当您单击 确定 时,会向 自定义规则集 列表中添加一个新项目,其中 名称 字段显示从 <ruleset> 标签内的 name 属性中检索到的规则集名称, File 字段显示所选规则集文件的位置。

Mess Detector 对话框

单击 “浏览”按钮 ,打开 配置 列表旁边的 Mess Detector 页面上的对话框。

使用此对话框配置所用的 PHP 解释器、Mess Detector 可执行文件的路径以及 Mess Detector 的行为。 有关更多信息,请参见 PHP Mess Detector

项目

描述

解释器窗格

对话框的左侧窗格显示用于 Mess Detector 的默认 PHP 解释器。 要添加不同的解释器,请单击 "添加"按钮 并从项目中配置的 CLI 解释器 列表中选择一个项目。

Mess Detector 路径

在此字段中,指定 Mess Detector 脚本的位置:Windows 使用 phpmd.bat ,Linux 和 macOS 使用 phpmd

PhpStorm 会检测 vendor/bin 文件夹中 Mess Detector 可执行文件的路径,并自动填写字段,但您可以根据需要进行编辑。 请手动输入路径或点击 “浏览”按钮 并在打开的对话框中选择路径。

要检查指定的 phpmd.bat phpmd 路径是否确保 PhpStorm 与 Mess Detector 之间的交互,即工具可以从 PhpStorm 启动并且 PhpStorm 会接收其问题报告,请单击 验证 按钮。 此验证等同于运行 phpmd --version 命令。 如果验证成功,PhpStorm 会显示检测到的 Mess Detector 版本信息。

工具进程超时

在此字段中,指定您希望 PhpStorm 等待 Mess Detector 返回结果的时间。 如果超时,进程将被终止以防止过多的 CPU 和内存使用。 这使您可以根据计算机的配置和使用的规则集微调 Mess Detector 的处理行为。

Psalm

在本节中,启用并配置 Psalm 质量工具。

项目

描述

配置

从列表中选择所需的解释器。 该列表包含所有当前配置的本地和远程 PHP 解释器。 如需更多信息,请参阅 配置本地 PHP 解释器配置远程 PHP 解释器

单击下拉列表右侧的 “浏览”按钮 打开 Psalm 对话框

显示忽略的文件

单击以打开 Psalm 忽略的文件 对话框,其中列出了 Psalm 跳过的文件。 PhpStorm 建议在检查期间,当等待 Psalm 的响应超过 工具进程超时 字段中指定的限制时,将新文件添加到列表中。 这样做是为了防止处理速度变慢。 对于每个文件,PhpStorm 会显示其名称和位置。

  • 要添加文件,请单击 "添加"按钮 并在打开的对话框中找到所需的文件。

  • 要从列表中删除文件并让 Psalm 再次处理它,请选择该文件并单击 移除文件 按钮 "移除"按钮

  • 要从列表中删除所有文件,请单击 关闭按钮

配置文件

提供 Psalm 配置文件 的路径。 如果文件不存在,PhpStorm 会显示通知,提示您创建它。

未找到 Psalm 配置的通知

显示信息(S)

选中复选框以让 Psalm 报告低于配置文件中指定的 errorLevel 的错误。 如果未选中复选框,则会忽略此类错误。

查找未使用的代码(F)

选中复选框以让 Psalm 报告定位到的未使用代码(包括未使用的变量)。

查找未使用的@psalm-suppress 注解

选中复选框以让 Psalm 报告所有未使用的 @psalm-suppress 注解。

Psalm 对话框

单击 “浏览”按钮 ,打开 配置 列表旁边的 Psalm 页面上的对话框。

使用此对话框配置所用的 PHP 解释器、Psalm 可执行文件的路径以及 Psalm 的行为。 有关更多信息,请参见 Psalm

项目

描述

解释器窗格

对话框的左侧窗格显示用于 Psalm 的默认 PHP 解释器。 要添加不同的解释器,请单击 "添加"按钮 并从项目中配置的 CLI 解释器 列表中选择一个项目。

Psalm 路径

在此字段中,指定 Psalm 脚本的位置:Windows 使用 psalm.bat ,Linux 和 macOS 使用 psalm

PhpStorm 会检测 vendor/bin 文件夹中 Psalm 可执行文件的路径,并自动填写字段,但您可以根据需要进行编辑。 请手动输入路径或点击 “浏览”按钮 并在打开的对话框中选择路径。

要检查指定的 psalm.bat psalm 路径是否确保 PhpStorm 与 Psalm 之间的交互,即工具可以从 PhpStorm 启动并且 PhpStorm 会接收其问题报告,请单击 验证 按钮。 此验证等同于运行 psalm --version 命令。 如果验证成功,PhpStorm 会显示检测到的 Psalm 版本信息。

工具进程超时

在此字段中,指定您希望 PhpStorm 等待 Psalm 返回结果的时间。 如果超时,进程将被终止以防止过多的 CPU 和内存使用。 这使您可以根据计算机的配置和使用的规则集微调 Psalm 的处理行为。

PHPStan

在本节中,启用并配置 PHPStan 质量工具。

项目

描述

配置

从列表中选择所需的解释器。 该列表包含所有当前配置的本地和远程 PHP 解释器。 如需更多信息,请参阅 配置本地 PHP 解释器配置远程 PHP 解释器

单击下拉列表右侧的 “浏览”按钮 打开 PHPStan 对话框

显示忽略的文件

单击以打开 PHPStan 忽略的文件 对话框,其中列出了 PHPStan 跳过的文件。 PhpStorm 建议在检查期间,当等待 PHPStan 的响应超过 工具进程超时 字段中指定的限制时,将新文件添加到列表中。 这样做是为了防止处理速度变慢。 对于每个文件,PhpStorm 会显示其名称和位置。

  • 要添加文件,请单击 "添加"按钮 并在打开的对话框中找到所需的文件。

  • 要从列表中删除文件并让 PHPStan 再次处理它,请选择该文件并单击 移除文件 按钮 "移除"按钮

  • 要从列表中删除所有文件,请单击 关闭按钮

完整项目运行(仅批处理模式)

使用该选项选择是否在检查运行范围中包含整个项目或仅包含其 源根目录

级别

提供所需的 规则级别 ,以便 PHPStan 执行检查。 请注意,如果提供了配置文件,PhpStorm 将依赖于该文件中指定的 级别 值,并忽略 级别 字段。

配置文件

提供 PHPStan 配置文件 的路径。

自动加载文件

提供自动加载器的路径。 请注意,如果提供了配置文件,PhpStorm 将依赖于该文件中指定的 autoload-file 值,并忽略 自动加载文件 字段。

内存限制

提供 PHPStan 允许分配的最大 RAM 量。 您可以提供以字节为单位的明确整数值,或使用 简写表示法500M4G 等)。

PHPStan 对话框

单击 “浏览”按钮 ,打开 配置 列表旁边的 PHPStan 页面上的对话框。

使用此对话框配置所用的 PHP 解释器、PHPStan 可执行文件的路径以及 PHPStan 的行为。 有关更多信息,请参见 PHPStan

项目

描述

解释器窗格

对话框的左侧窗格显示用于 PHPStan 的默认 PHP 解释器。 要添加不同的解释器,请单击 "添加"按钮 并从项目中配置的 CLI 解释器 列表中选择一个项目。

PHPStan 路径

在此字段中,指定 PHPStan 脚本的位置:Windows 使用 phpstan.bat ,Linux 和 macOS 使用 phpstan

PhpStorm 会检测 vendor/bin 文件夹中 PHPStan 可执行文件的路径,并自动填写字段,但您可以根据需要进行编辑。 请手动输入路径或点击 “浏览”按钮 并在打开的对话框中选择路径。

要检查指定的 phpstan.bat phpstan 路径是否确保 PhpStorm 与 PHPStan 之间的交互,即工具可以从 PhpStorm 启动并且 PhpStorm 会接收其问题报告,请单击 验证 按钮。 此验证等同于运行 phpstan --version 命令。 如果验证成功,PhpStorm 会显示检测到的 PHPStan 版本信息。

工具进程超时

在此字段中,指定您希望 PhpStorm 等待 PHPStan 返回结果的时间。 如果超时,进程将被终止以防止过多的 CPU 和内存使用。 这使您可以根据计算机的配置和使用的规则集微调 PHPStan 的处理行为。

外部格式化工具

在本节中,您可以设置一些代码质量工具,以在 代码重新格式化 期间用作外部格式化器。

项目

描述

外部格式化工具

以下代码质量工具可用作外部格式化器:

  • PHP Code Beautifier and Fixer :选择此项,如果在 PHP_CodeSniffer 部分中配置了 PHP_CodeSniffer 和 PHP Code Beautifier and Fixer 工具。

  • PHP CS Fixer :选择此项,如果在 PHP CS Fixer 部分中配置了 PHP CS Fixer 工具。

  • Laravel Pint :选择此项,如果在 Laravel Pint 部分中配置了 Laravel Pint 工具。

  • 无外部格式化程序 :选择此项以使用 PhpStorm 内置的代码格式化规则。 当配置了多个或未配置代码质量工具时的默认选项。

最后修改日期: 2025年 9月 26日