Softonic

整理 PHP 代码片段

步 1 / 2
下一步

难以阅读的代码片段得到的回答更少。把代码粘贴到这里，每条语句都会独占一行，缩进也保持一致。然后复制到你的工单、聊天消息、论坛问题或文档中。只需几秒钟，最适合简短的示例。

如何准备用于分享的代码片段

  1. 1

    先精简代码

    删除与问题无关的内容，并把密码、密钥和真实姓名替换为占位符。

  2. 2

    粘贴代码

    把精简后的代码片段放入 PHP 代码框，然后选择 2 或 4 个空格。

  3. 3

    进入结果

    打开整理后的版本。

  4. 4

    复制并发布

    与原文对照检查，然后粘贴到你发布内容所在位置的代码块中。

格式为什么能帮助读者

人们是通过代码的形状来扫读代码的。大括号对齐、每条语句各占一行时，读者在读懂任何一个词之前就能看清结构。审阅者也能一眼发现漏掉的大括号或位置错误的循环。而一大段没有换行的文本会把这些全部隐藏起来。

整理前后对比

原始代码，从日志中复制：

<?php function total($items){$sum=0;foreach($items as $item){$sum+=$item["price"];}return $sum;}

使用 4 个空格整理后：

<?php function total($items)
{
    $sum=0;
    foreach($items as $item)
    {
        $sum+=$item["price"];
    }
    return $sum;
}

发布前的简短检查清单

  • 删除机密信息。你在这里粘贴的文本会在我们的服务器上处理，因此不要使用真实的凭据、令牌或客户数据。
  • 保持示例精简，只保留展示问题所需的代码行。
  • 说明你使用的 PHP 版本，以及你原本期望的结果。
  • 将格式化后的代码与原始代码对照。本工具只改变排版，但空白字符的规则可能影响注释和字符串。
  • 把结果放入代码块中，以保持缩进。

本工具不做什么

它不会查找错误、运行你的代码或检查风格规则。整洁的排版能让问题更容易看清，但不能修复问题。

适用场景

  • 包含代码示例的支持工单或错误报告。
  • 开发者论坛或聊天频道中的提问。
  • 需要整洁示例的文档或教程页面。
  • 建议修改函数某一部分的代码审查评论。

在每种情况下，读者都会先看到结构，再看到问题，这正是你希望的顺序。

保持代码片段的真实性

请格式化你实际要发布的代码，而不是更干净的改写版本。如果为了让示例更短而缩写了变量名或删除了某些行，请先自己运行缩短后的版本。一段整洁却无法重现问题的代码片段只会浪费读者的时间。如果你要附上预期结果的说明，请用简单的语言把它写在代码块上方。

常见问题

不应该。请先把密码、密钥和个人数据替换为占位符。粘贴的文本会被发送到我们的服务器进行格式化。

对于普通代码，它只改变空白字符。注释、heredoc 以及包含逗号的字符串可能会被改动，因此请将输出与原文对照。

不能。它既不检查语法，也不运行代码片段，只是改善代码的排版。

本工具适用于简短的代码片段。对于长文件，你在编辑器中配置的格式化工具更合适。

相关工具

Webpack 配置生成器

为纯 JavaScript、React 或 Vue 项目生成 webpack 5 的 webpack.config.js：支持 TypeScript、Babel、CSS 或 Sass、图片、HtmlWebpackPlugin、开发服务器，并给出 npm install 命令。

ASCII 表参考

完整 ASCII 表，覆盖 0 到 127；列出每个代码的十进制、十六进制、八进制、二进制值和 HTML 数字字符引用写法，包括 NUL、LF、DEL。

Protocol Buffers 解码器

在浏览器中解码 hex、Base64、Base64URL、文本或文件中的 Protobuf 线格式字节，准确检查字段候选解释并导出私密报告。

XML 格式化工具

以一致的缩进美化 XML 文档，并精确定位到行号，捕获格式良好性错误。

HTML 字符参考

可搜索的 HTML 实体列表，含命名代码与数值代码，并支持一键复制特殊字符和符号。

文件大小转换器

在字节、KB、MB、GB、TB及IEC二进制单位（KiB、MiB、GiB、TiB）之间转换，可自由组合十进制与二进制。

此工具还提供其他语言版本

使用指南与应用场景