需要将代码注释放入定界文档中

Question

好吧，我似乎无法在 foo.php 文件的 heredoc 块内添加注释：

echo <<<_HEREDOC_FOO

       // okay this comment was intended to explain the code below but it
       // is showing up on the web page HTML sent to the browser

      <form action="foo.php" method="post">
      <input type="submit" value="DELETE RECORD" /></form>

_HEREDOC_FOO;

表单是否有效，当然（顺便说一句，上面的表单代码是 高度截断 为了我的问题）。

但是该死的评论（好吧，这个评论是..blah blah blah） 也出现在浏览器中。它显示在 浏览器就像上面写的那样：

// okay this comment was intended to explain the code below but it
// is showing up on the web page HTML sent to the browser

我尝试过的评论分界的排列：

// <--  
// -->

和...

<-- //
--> //

在这两种情况下都失败，无法允许我在 heredoc 内发表评论。

那么我到底怎样才能在我的 heredoc 中注释我的代码呢？

Answer 1

这是设计使然。一旦你成为你的heredoc，你输入的所有内容直到你结束它都会被视为一个长字符串的一部分。你最好的选择是打破你的 HEREDOC，发表你的评论，然后开始一个新的回显行

echo <<<_HEREDOC_FOO
    text text text
<<<_HEREDOC_FOO;
//Comments
echo <<<_HEREDOC_FOO
    text text text
<<<_HEREDOC_FOO;

正如其他人提到的，你可以做 HTML 评论，但那些查看你的源代码的人仍然可以看到

Answer 2

您可以将注释字符串作为变量函数的参数传递。

function heredocComment($comment)
{
    return "";
}

$GLOBALS["heredocComment"] = "heredocComment";

echo <<<_HEREDOC_FOO

   {$heredocComment("
   okay this comment was intended to explain the code below but it
   is showing up on the web page html sent to the browser
   ")}

  <form action="foo.php" method="post">
  <input type="submit" value="DELETE RECORD" /></form>

_HEREDOC_FOO;

Answer 3

试试这个：

echo <<<_HEREDOC_FOO

       <!-- okay this comment was intended to explain the code below but it
            is showing up on the web page html sent to the browser -->

      <form action="foo.php" method="post">
      <input type="submit" value="DELETE RECORD" /></form>

_HEREDOC_FOO;

它现在是一个 HTML 评论

Answer 4

实际执行此操作的最简单方法是使用与 SeppoTaalasmaa 使用的相同策略，但更短：

$comment = function($str) {return '';};
echo <<<_HEREDOC_FOO

       {$comment('okay this comment was intended to explain the code below but it
       is showing up on the web page html sent to the browser')}

      <form action="foo.php" method="post">
      <input type="submit" value="DELETE RECORD" /></form>

_HEREDOC_FOO;

只需添加定义 $comment 的第一行，您就可以在下一个heredoc中插入注释方式。如果您不在全局范围内定义该函数，这也将起作用。