如何在PHP的echo输出中添加换行符以生成便于调试的HTML源代码

以下为对应故障的排查方向及解决方法：

• 检查换行符是否被单引号包裹

PHP中单引号包裹的字符串不会解析转义字符（如\n、\r），如果你的实际代码中使用单引号包裹带换行符的内容，换行符会被当作普通文本输出，不会生效。
解决方法：输出带转义字符的内容时统一使用双引号包裹，PHP_EOL为系统自适应换行符，不受引号类型影响，优先使用该常量定义换行。

• 检查是否存在输出压缩/过滤逻辑
  优先排查运行环境的以下配置：
  • PHP配置项zlib.output_compression是否开启，或是Apache/Nginx等Web服务器开启了自动压缩响应内容的模块，部分压缩规则会默认删除多余的空白字符和换行
  • 所用框架、自定义代码中是否注册了输出回调函数，对响应内容做了去空白、压缩格式化处理
    解决方法：调试阶段临时关闭输出压缩功能，或是在压缩规则中排除调试环境的响应即可看到原始换行。
• 确认换行是否真实存在
  可跳过浏览器直接校验：在命令行运行对应PHP脚本，或是将输出内容写入本地文本文件后用系统记事本打开，确认换行是否真实存在。如果本地文件有换行，仅Firefox查看源码时不显示，可检查Firefox源码查看器的设置，确认是否误关了自动换行选项。

最优实践方案 #

如果PHP代码中有大量HTML需要输出，推荐使用PHP原生混写语法，不需要手动拼接换行符，可读性和可维护性更高：

<?php
// 此处写PHP业务逻辑
$user = '测试用户';
?>
<!-- 直接书写HTML内容，原生换行会完整保留到输出中 -->
<html>
<body>
  你好，<?= $user ?>
  <p>这是段落内容</p>
</body>
</html>
<?php
// 后续PHP逻辑
?>

如果必须通过echo输出大量HTML，可以使用heredoc/nowdoc语法，直接保留内部的换行格式：

<?php
echo <<<HTML
<html>
<body>
  Hello, World!
</body>
</html>
HTML;
?>

内容的提问来源于stack exchange，提问作者Weather Vane