简介与代码检查

约 488 字大约 2 分钟

2026-06-30

目录
简介
PHP 代码质量工具
IDE 关闭检查提示
忽略代码提示的方法
创建 PHPCS 配置文件

简介

PhpStorm 是由 JetBrains 出品的 PHP 集成开发环境 (IDE)，旨在最大程度提高开发效率。内置对 HTML5、CSS、JavaScript、XML 和数据库的支持，可通过插件扩展其他语言支持。

PHP 代码质量工具

PHP_CodeSniffer (PHPCS) — PHP 代码风格检查工具，可检测代码是否符合 PSR 等编码规范。

IDE 关闭检查提示

注释	适用工具
`@noinspection ALL`	PhpStorm IDE 内置检查
`phpcs:disable Generic.Files.LineLength`	PHP_CodeSniffer (PHPCS)

忽略代码提示的方法

在文件开头添加忽略注释

// php 文件
// phpcs:disable Generic.Files.LineLength
// @noinspection ALL

// 2.js 文件
// phpcs:ignoreFile
// phpcs:disable PSR12.Operators.OperatorSpacing  // 针对特定规则

在特定行后添加忽略注释

some_long_line(); // phpcs:ignore Generic.Files.LineLength.TooLong

配置 IDE 忽略特定文件类型

在 PhpStorm 中排除特定目录的检查：

打开 File → Settings → Editor → Inspections
搜索 PHP Code Sniffer
在右侧的 Scope 设置中，排除路由文件目录

直接修改 ruleset.xml 文件

如需排除 PSR1.Classes.ClassDeclaration.MissingNamespace 提示，找到对应的 ruleset.xml 文件（如 vendor\squizlabs\php_codesniffer\src\Standards\PSR1\ruleset.xml），加入：

<rule ref="PSR1.Classes.ClassDeclaration">
    <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/>
</rule>

创建 PHPCS 配置文件

在项目根目录创建 .phpcs.xml 文件，自定义检查规则：

<?xml version="1.0"?>
<ruleset name="Custom PHPCS Rules">
    <description>Custom PHP Code Sniffer rules for the project</description>

    <!-- 忽略路由文件的行长度检查 -->
    <rule ref="Generic.Files.LineLength">
        <exclude-pattern>*/routes/*</exclude-pattern>
    </rule>

    <!-- 或者增加行长度限制 -->
    <rule ref="Generic.Files.LineLength">
        <properties>
            <property name="lineLimit" value="150"/>
            <property name="absoluteLineLimit" value="200"/>
        </properties>
    </rule>
</ruleset>