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

我听到有人说有,所以我想知道。

HTML评论:

<!-- Comment goes here. --> 

PHP评论:

 <?php // Comment goes here. ?> 

与HTML注释不同,PHP注释在最终输出中不显示。 这往往是可取的,因为评论通常是内部的笔记,而不是任何人的业务。

PHP注释将不会在客户端的源代码中显示,HTML注释将在该源代码中显示。 所以问题是:你想要评论是由最终用户可读吗?

正如其他用户所说,PHP注释不会显示在输出HTML中。 这有两个主要的影响:

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

小的HTML注释对前端开发人员可能是有用的,例如在大文件中指定结束标记的标识符:

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

这些评论可以是非常有用的,并且对页面大小几乎没有影响。

在您的显示代码中,PHP注释应该保持在最低限度,因为不应该有太多的PHP来评论(尽pipe这是一个完全不同的主题)。

不用说,你只能用PHP注释来评论PHP,用HTML注释来评论HTML。 如果你发现自己不得不写很长的HTML注释来向你的前端开发者解释一些古怪的HTML,这可能是一个坏的迹象。

真的取决于你在评论什么。 除了所有其他的答案之外,我还有一些可以真正重要的东西。 有时,我们的编码人员需要注释掉一段代码,例如:

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

假设$results长度是20,每个div的字符长度大约是500 Bytes(一个中等密度的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运行这个巨大的y循环没有任何东西。

当然,如果你使用的是修订控制系统(例如git,svn),那么这些注释(包含运行代码而不是描述的注释)应该被完全删除。

有时候html的注释是非常有用的,当你需要得到的信息,不能在HTML浏览器呈现。

例如你需要知道发送了html页面的服务器的ip,你不能在html页面中显示..你打印它作为html的注释,所以你可以检查在html源代码中的信息