¥
立即购买

PHP代码格式化优化器

4 浏览
1 试用
0 购买
Dec 8, 2025更新

本提示词专门用于PHP代码的格式化与可读性优化,能够自动识别代码结构并进行标准化排版。通过专业的代码分析能力,对缩进、空格、括号对齐、代码块分隔等关键格式要素进行智能调整,确保输出符合PHP开发规范。特别适用于重构遗留代码、团队协作统一代码风格、教学演示等场景,显著提升代码维护性和可读性。

格式化后的PHP代码

<?php

namespace App\Http\Controllers;

use App\Service\UserService;

class UserController
{
    public function show($id, $includePosts = false)
    {
        $svc = new UserService();

        $id = is_numeric($id) ? (int) $id : null;

        if ($id === null) {
            return response()->json(['error' => 'invalid id'], 400);
        }

        $user = $svc->findUserById($id);

        if (!$user) {
            return response()->json(['error' => 'not found'], 404);
        }

        $data = [
            'id' => $user->id,
            'name' => trim($user->name),
            'email' => $user->email,
        ];

        if ($includePosts) {
            $data['posts'] = array_map(
                function ($p) {
                    return [
                        'id' => $p->id,
                        'title' => $p->title,
                    ];
                },
                $svc->getPostsByUserId($id)
            );
        }

        return response()->json($data, 200);
    }
}

格式优化说明

  • 命名空间与use语句分行并在逻辑块之间添加空行:符合 PSR-12 对文件结构分隔的要求,提升可读性。
  • 类与方法的大括号风格:类的左大括号独占一行,方法的左大括号同一行结尾,符合 PSR-12 约定。
  • 缩进与空白:统一使用 4 个空格缩进;在二元运算符(=、? :、=>、,)两侧添加适当空格;移除不必要的内部空格,如函数调用和数组索引中的多余空格。
  • 控制结构规范:在 if 关键字后添加空格;小括号内不在开头与结尾处添加空格;大括号换行,符合 PSR-12。
  • 数组语法与对齐:统一为短数组语法 []; 多行数组每项独立一行并添加尾逗号,便于版本控制的差异比较。
  • 类型转换与函数参数空格:在 (int) 强制类型转换后添加空格;方法与函数参数的逗号后添加空格,提升可读性。
  • 匿名函数格式:function 与参数列表之间保留一个空格;函数体换行并缩进,符合 PSR-12 对闭包的格式要求。
  • 长行拆分:对 array_map 的回调与参数进行多行拆分,控制行宽与视觉层次。
  • 返回语句统一:response()->json 调用参数间空格统一,状态码与数据分隔清晰。

以上操作仅涉及格式与风格,未改动任何业务逻辑与行为。

技术建议

  • 类型声明:在不影响现有调用方的前提下,考虑为 $id 与 $includePosts 增加参数与返回类型声明(如:int|string|null、bool、Illuminate\Http\JsonResponse),并结合请求验证进一步收敛类型。
  • 依赖注入:建议通过构造函数或方法注入注入 UserService,便于测试与解耦(遵循依赖倒置原则)。
  • 文档块:为控制器与方法添加 PHPDoc,说明参数含义、可能的返回结果与异常场景,辅助团队协作与静态分析。
  • 数据转换层:考虑使用资源类/Transformer(如 Laravel Resource)统一输出结构与字段映射,便于后续扩展与版本化。
  • 大数据处理:当 includePosts 为真且帖子数据较大时,建议分页或限制字段,以控制响应体大小与接口性能。

格式化后的PHP代码

<?php

function build_config($input)
{
    $defaults = [
        'debug'   => false,
        'cache'   => true,
        'modules' => [],
    ];

    $config = array_merge($defaults, (array) $input);

    $config['modules'] = array_values(
        array_unique(array_map('strtolower', $config['modules']))
    );

    usort($config['modules'], function ($a, $b) {
        if ($a === $b) {
            return 0;
        }

        return ($a < $b) ? -1 : 1;
    });

    if (!isset($config['env']) || $config['env'] === '') {
        $config['env'] = 'prod';
    }

    return $config;
}

格式优化说明

  • 缩进与空白

    • 统一使用4个空格缩进,移除Tab字符,符合PSR-2缩进规范。
    • 在运算符(=、=>、===、<)两侧添加空格,提升可读性并符合PSR-2关于运算符的空格约定。
    • 将类型转换由(array)$input调整为(array) $input,确保类型转换与操作数之间保留一个空格(PSR-2对类型转换的通用空格风格)。
  • 括号与大括号位置

    • 函数的开括号放在函数声明的下一行,闭括号独占一行,符合PSR-2函数/方法定义规范。
    • 控制结构(if)左花括号与关键字同行,右花括号独占一行,符合PSR-2控制结构风格。
  • 参数与逗号

    • 函数参数、数组项的逗号后加入空格,提升可读性并与PSR-2一致。
  • 闭包格式

    • 匿名函数在function关键字后添加空格,参数列表与花括号间添加必要空格,符合PSR-2对闭包的要求。
    • 为闭包体内的不同逻辑分支增加空行分隔,增强可读性。
  • 数组与长表达式分行

    • 默认配置数组按键值对逐行排列,并对齐箭头=>两侧空格,便于扫描阅读(不改变逻辑)。
    • 对嵌套调用(array_values/array_unique/array_map)进行换行与缩进,控制行长度并提升层次感,符合PSR-2对长行的建议处理方式。
  • 语句分隔与空行

    • 在逻辑块之间增加空行(默认配置、合并输入、模块标准化、排序、env设置、返回),增强代码的视觉结构层次。
  • 功能保持

    • 未更改任何业务逻辑与行为,所有调整仅为格式与可读性优化。

技术建议

  • 文档注释

    • 为函数添加PHPDoc块,明确参数与返回类型,例如:
      • @param mixed $input
      • @return array
    • 说明$input预期结构(如包含modules、env等),便于协作与静态分析。
  • 命名与规范

    • 若项目统一遵循某种命名约定(如camelCase),可将build_config调整为buildConfig(仅在不影响项目约定与兼容性的前提下)。
  • 静态分析与校验

    • 接入代码风格检查工具(如PHP_CodeSniffer)并使用PSR-2规则集,保证团队协作中的一致性。
    • 可结合PHP-CS-Fixer配置规则,自动化保证上述空格、缩进、闭包与数组格式。
  • 版本与类型

    • 若运行环境支持,后续可在不改变逻辑的前提下引入参数与返回类型声明,以提升类型安全(例如:function build_config($input): array),需要评估兼容性后再行调整。
  • 测试覆盖

    • 建议为关键用例编写单元测试(modules大小写混合、重复项、空env、缺失env、非数组输入等),确保格式化后与后续重构过程中的行为一致性。

格式化后的PHP代码

<?php

class Report
{
    public $rows = [];

    public function add($label, $value)
    {
        $this->rows[] = [
            'label' => $label,
            'value'  => $value,
        ];
    }

    public function render()
    {
        $w = 0;

        foreach ($this->rows as $r) {
            $w = max($w, strlen($r['label']));
        }

        foreach ($this->rows as $r) {
            echo str_pad($r['label'], $w, ' ', STR_PAD_RIGHT)
                . ' : '
                . $r['value']
                . PHP_EOL;
        }
    }
}

$report = new Report();

foreach ($argv as $i => $arg) {
    if ($i === 0) {
        continue;
    }

    list($k, $v) = array_pad(explode('=', $arg, 2), 2, '');

    if ($k !== '') {
        $report->add($k, $v !== '' ? $v : '(empty)');
    }
}

$report->render();

格式优化说明

  • 结构化换行与缩进
    • 采用每级4个空格缩进,提升层级结构可读性。
    • 类、方法的花括号各占一行,符合PSR风格。
    • 将多条语句拆分为单行表达,避免同一行包含多条指令。
  • 空白与空行管理
    • 在类成员、方法、控制结构之间增加必要的空行,分隔逻辑块。
    • 在二元运算符、逗号、数组键值对的冒号周围添加空格,统一空格风格。
  • 可见性声明
    • 为类方法显式声明为public(等同于默认可见性,不改变行为),提高接口意图清晰度。
  • 输出拼接可读性
    • 对长行echo进行分行拼接,点号操作符前后保留空格,减少横向滚动,便于审阅。
  • 数组风格
    • 使用短数组语法[]并对齐键值对,保持风格一致。
  • 保持逻辑与行为不变
    • 未引入类型声明、严格模式或任何影响运行时行为的变更;仅进行格式与可读性优化。

技术建议

  • 统一规范与工具链
    • 建议在项目中采用PSR-12基础规范,结合自定义规则落地,并通过PHP_CodeSniffer或PHP-CS-Fixer在CI中自动校验与修复。
  • 终端对齐的多字节字符场景
    • 如需处理多字节字符(中文、日文等)对齐,可评估mb_strlen/mb_strwidth与合适的填充策略,以避免宽度计算偏差。
  • I/O与脚本入口
    • 若作为可执行脚本使用,可在入口处添加参数校验与帮助信息(例如--help),并在需要时为类拆分文件与命名空间,便于复用与测试。

示例详情

解决的问题

用最少的操作,让凌乱的 PHP 代码一键变“干净、统一、好读”。具体包括:

  • 标准化排版与风格统一,遵循行业主流规范
  • 严格保持原有逻辑不变,只做可读性与结构层面的优化
  • 自动生成“做了什么、为何这样做”的格式化说明,帮助团队建立一致的评审口径
  • 适配重构、代码评审、项目交接、教学演示等高频场景
  • 显著缩短代码评审与协作沟通成本,提升维护效率与新人上手速度
  • 作为团队的“代码风格守门员”,让规范落地可持续、可复用

适用用户

后端团队负责人

一键规范全仓库风格,减少PR无关差异,沉淀统一规范模板,显著提升跨组协作效率与交付质量。

PHP开发工程师

提交前自动整理代码,修正缩进与对齐,逻辑零改动,降低评审返工率,专注实现核心需求。

代码评审者与质量保障

通过格式化说明快速定位问题来源,过滤排版噪音,聚焦逻辑与边界用例,缩短评审周期。

特征总结

自动识别函数、类与控制结构,按主流规范重排,老旧脚本瞬间焕新易读。
一键统一缩进、空格与括号对齐,团队风格一致,减少合并冲突与评审摩擦。
智能划分代码块与空行层次,复杂逻辑更清楚,排错定位更迅速更省心。
严格保留业务行为不变,只调整排版与注释,重构与排查过程更安心可控。
可按项目约定灵活微调风格,满足不同仓库与子模块习惯,统一而不僵硬。
自动生成格式化说明与决策依据,帮助新人快速理解团队写法与规范来由。
适配代码审查、提交与交接场景,显著压缩评审时长,提高合并通过概率。
为教学演示与文档准备清爽示例,语法高亮结构清晰,呈现更专业可信。

如何使用购买的提示词模板

1. 直接在外部 Chat 应用中使用

将模板生成的提示词复制粘贴到您常用的 Chat 应用(如 ChatGPT、Claude 等),即可直接对话使用,无需额外开发。适合个人快速体验和轻量使用场景。

2. 发布为 API 接口调用

把提示词模板转化为 API,您的程序可任意修改模板参数,通过接口直接调用,轻松实现自动化与批量处理。适合开发者集成与业务系统嵌入。

3. 在 MCP Client 中配置使用

在 MCP client 中配置对应的 server 地址,让您的 AI 应用自动调用提示词模板。适合高级用户和团队协作,让提示词在不同 AI 工具间无缝衔接。

AI 提示词价格
¥20.00元
先用后买,用好了再付款,超安全!

您购买后可以获得什么

获得完整提示词模板
- 共 565 tokens
- 3 个可调节参数
{ PHP代码 } { 代码用途 } { 格式化标准 }
获得社区贡献内容的使用权
- 精选社区优质案例,助您快速上手提示词
使用提示词兑换券,低至 ¥ 9.9
了解兑换券 →
限时半价

不要错过!

半价获取高级提示词-优惠即将到期

17
:
23
小时
:
59
分钟
:
59