在HTML代码中使用PHP注释而不是HTML注释有什么好处？

Question

我听到有人说有，所以我在想。

HTML评论：

<!-- Comment goes here. -->

PHP评论：

<?php // Comment goes here. ?>

Answer 1

与HTML注释不同，PHP注释不会显示在最终输出中。这通常是可取的，因为评论通常是内部注释，不属于任何人的业务。

Answer 2

PHP注释将不会出现在HTML注释所在的客户端上。所以问题是：你想让评论最终用户可读吗？

Answer 3

PHP注释不会像其他用户所说的那样出现在输出HTML中。这有两个主要影响：

1. PHP注释对最终用户隐藏。这已经被涵盖了...而且，
2. PHP评论不会通过互联网发送。这将为最终用户带来一点性能提升。这样做的好处当然取决于你的冗长程度。

Answer 4

小HTML注释对前端开发人员非常有用，例如在大文件中指定结束标记的标识符：

<div id="container">
    ... Hundreds or thousands of lines of HTML
</div> <!-- #container -->

这些评论可以非常有用，对页面大小影响很小或没有影响。

在显示代码中应该将PHP注释保持在最低限度，因为不应该有大量的PHP要评论（尽管这是一个完全不同的主题）。

不言而喻，您应该只使用PHP注释评论PHP，并使用HTML注释评论HTML。如果您发现自己不得不编写长HTML评论来向前端开发人员解释一些古怪的HTML，那可能是一个不好的迹象。

Answer 5

真的取决于你评论的内容。除了所有其他答案，我还有一些非常重要的事情。我们的编码员有时需要注释掉一段代码，如：

<?php foreach ($results) { ?>
  <div>
    ... more divs ...
  </div>
<?php } ?>

假设$results的长度为20，每个div的字符长度约为500字节（中等密度的div）。然后我们在这里有10 KB的HTML。在这种情况下，两种评论方法将非常不同：

<?php /* foreach ($results) { ?>
  <div>
    ... more divs ...
  </div>
<?php } */ ?>

将零字节发送给访问者，并且没有PHP处理。

VS

<!-- <?php foreach ($results) { ?>
  <div>
    ... more divs ...
  </div>
<?php } ?> -->

仍然会向访问者发送10 KB，PHP无需任何操作就可以运行这个巨大的循环。

当然，如果您使用的是版本控制系统（例如git，svn），那么这些注释（包含运行代码而非描述的注释）应该完全删除。

Answer 6

当您需要获取浏览器无法在html中呈现的信息时，有时html注释很有用。

例如，您需要知道发送html页面的服务器的ip，您无法在html页面中显示..您将其打印为html注释，以便您可以在html源代码中检查该信息