如何评论出包含PHP的HTML代码?

发布时间:2022-04-30 发布网站:脚本宝典
脚本宝典收集整理的这篇文章主要介绍了如何评论出包含PHP的HTML代码?脚本宝典觉得挺不错的,现在分享给大家,也给大家做个参考。
我有一个包含 PHPHTML代码,我想对它进行全面评论.
<input tyPE="hidden" name="returnurl" value="<?PHP if (!empty($link)) {echo $link;}?>">

何在不单独评论的情况下注释HTMLPHP

感谢Ross Patterson,我发现我完全误解了这个问题.所以这是新答案.我保留下面的旧答案,因为它可能对某些人有用.

新答案

你的情况很简单,因为你的代码中既没有PHP字符串也没有注释.这意味着对这段特定代码进行注释非常简单:

<?PHP
/*
<input type="hidden" name="returnurl" value="<?PHP if (!empty($link)) {echo $link;}?>">
*/
?>

问题是你迟早会发现自己处于不起作用的情况,因为评论代码包含自己的注释.想象一下以下代码

<div>
  You're LOGged in.
  <?PHP
  /**
   * Says "hello" to the person.
   * @param string $name The name of the person.
   */
  function SayHello($name)
  {
    echo 'Hello,' . $name;
  }

  SayHello($personName);
  ?>
</div>

您不可能将其嵌入到单个注释中,因为它将在第7行中断开.

相反,您可以使用NOWDOC syntax代码嵌入到字符串中,并且永远不会使用此字符串:

<?PHP
$GUID2328f09280b94c22867d831a885b57eb = <<<'GUID2328f09280b94c22867d831a885b57eb'
<div>
  You're logged in.
  <?PHP
  /**
   * Says "hello" to the person.
   * @param string $name The name of the person.
   */
  function SayHello($name)
  {
    echo 'Hello,' . $name;
  }

  SayHello($personName);
  ?>
</div>
GUID2328f09280b94c22867d831a885b57eb
?>

几点评论

>为什么我使用NowDOC而不是简单的字符串?

一个简单的字符串将在第5行断开(在“说”你好“”).单引号字符串将在第2行(在“你是”上)中断.
>为什么我使用NowDOC代替HEredOC?

因为我不希望解析变量名.在这样的上下文中解析变量会导致很难找到和调试的问题,因为范围会发生变化.
>这个可怕的GUID2328是什么……?

我使用GUID来确保,首先,字符串永远不会在实际结束之前终止,其次,字符串变量将永远不会在代码中后来合理使用.我输入了GUID前缀,因为HEREDOC / NowDOC要求名称以字母开头,而不是数字.

如果你发现它丑陋而愚蠢,请随意使用你想要的任何语法.
>它会影响网络应用程序的性能,对吧?

不要过早优化.初始化一个字符串可能会有性能成本,但它要么小到可以关心,要么甚至PHP解释器都足够聪明以优化代码删除未使用的字符串(我非常怀疑).

请注意,您不应该首先评论大块代码.如果您不需要代码,只需将其删除即可.如果您认为以后可能需要它,请让版本控制处理它(您正在使用版本控制,是吗?).

老答案

你在评论谁?

>开发人员?然后用PHP评论.例:

<?PHP /** The value is hidden for the moment to be backwards compatible,but the field
        * would be removed in the near Future,since having this field PResents a
        * security risk. See bug report 1422,http://example.COM/bugs/1422 */ ?>
<input type="hidden" name="returnurl" value="<?PHP if (!empty($link)) {echo $link;}?>">

请记住,HTML评论是公开显示的.在上面的示例中添加评论是对黑客的礼物.
>用户?然后用HTML评论.例:

<!-- If `returnurl` is null or empty,the client would be redirected to the home page
     of the websITe. -->
<input type="hidden" name="returnurl" value="<?PHP if (!empty($link)) {echo $link;}?>">

在这里,目的是告诉用户有用的东西,例如屏幕废弃你的网站或做一些操纵HTML的东西(唯一有效的例子我会看到做一个真正的API对你来说太贵了,所以你是授权和邀请用户直接解析HTML代码).

请记住:

>每个人都可以看到HTML评论,> HTML注释被发送到客户端,增加带宽的使用.注意:在大多数情况下,你不在乎;除非您在GOOGLE主页上工作,否则这不会影响您网站的性能.

脚本宝典总结

以上是脚本宝典为你收集整理的如何评论出包含PHP的HTML代码?全部内容,希望文章能够帮你解决如何评论出包含PHP的HTML代码?所遇到的问题。

如果觉得脚本宝典网站内容还不错,欢迎将脚本宝典推荐好友。

本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。