注释

优质

小牛编辑

126浏览

2023-12-01

注释是一段代码，任何Web浏览器都会忽略它。最好在HTML代码中添加注释，特别是在复杂文档中，以指示文档的各个部分，以及任何查看代码的人的任何其他注释。注释可帮助您和其他人理解您的代码并提高代码可读性。

HTML注释放在《!-- ... --》标签之间。因此，任何放入“！ - ... - ”标签的内容都将被视为注释，浏览器将完全忽略这些内容。

例子 (Example)

<!DOCTYPE html>
<html>
   <head>  <!-- Document Header Starts -->
      <title>This is document title</title>
   </head> <!-- Document Header Ends -->
   <body>
      <p>Document content goes here.....</p>
   </body>
</html>

有效与无效的评论

注释不嵌套，这意味着注释不能放在另一个注释中。其次，除了作为结束 - >标签的一部分之外，双短划线序列“ - ”可能不会出现在注释中。您还必须确保start-of注释字符串中没有空格。

例子 (Example)

在这里，给定的评论是有效的评论，将被浏览器删除。

<!DOCTYPE html>
<html>
   <head>
      <title>Valid Comment Example</title>
   </head>
   <body>
      <!--   This is valid comment -->
      <p>Document content goes here.....</p>
   </body>
</html>

但是，以下行不是有效的注释，将由浏览器显示。这是因为左尖括号和感叹号之间有一个空格。

<!DOCTYPE html>
<html>
   <head>  
      <title>Invalid Comment Example</title>
   </head>
   <body>
      < !--   This is not a valid comment -->
      <p>Document content goes here.....</p>
   </body>
</html>

多行评论

到目前为止，我们已经看到了单行注释，但HTML也支持多行注释。

您可以通过特殊的开始标记放置在第一行和最后一行的结尾之前对多行进行注释，如下面给出的示例所示。

例子 (Example)

<!DOCTYPE html>
<html>
   <head>  
      <title>Multiline Comments</title>
   </head> 
   <body>
      <!-- 
         This is a multiline comment and it can
         span through as many as lines you like.
      -->
      <p>Document content goes here.....</p>
   </body>
</html>

条件评论

条件注释仅适用于Windows上的Internet Explorer（IE），但其他浏览器会忽略它们。从Explorer 5开始支持它们，您可以使用它们为不同版本的IE提供条件指令。

例子 (Example)

<!DOCTYPE html>
<html>
   <head>  
      <title>Conditional Comments</title>
      <!--[if IE 6]>
         Special instructions for IE 6 here
      <![endif]-->
   </head> 
   <body>
      <p>Document content goes here.....</p>
   </body>
</html>

您将遇到需要根据不同版本的Internet Explorer应用不同样式表的情况，在这种情况下，条件注释将很有帮助。

使用评论标签

很少有浏览器支持标记来评论HTML代码的一部分。

Note - HTML5中不推荐使用“comment”标记。不要使用此元素。

例子 (Example)

<!DOCTYPE html>
<html>
   <head>
      <title>Using Comment Tag</title>
   </head>
   <body>
      <p>This is <comment>not</comment> Internet Explorer.</p>
   </body>
</html>

评论脚本代码

虽然您将在单独的教程中学习使用HTML的JavaScript，但是在这里您必须注意，如果您在HTML代码中使用Java Script或VB Script，那么建议将该脚本代码放在适当的HTML注释中，以便旧的浏览器可以正常工作。

例子 (Example)

<!DOCTYPE html>
<html>
   <head>
      <title>Commenting Script Code</title>
      <script>
         <!-- 
            document.write("Hello World!")
         //-->
      </script>
   </head>
   <body>
      <p>Hello , World!</p>
   </body>
</html>

评论样式表

虽然您将学习在单独的教程中使用带有HTML的样式表，但是在这里您必须注意，如果您在HTML代码中使用层叠样式表（CSS），那么建议将该样式表代码放在适当的HTML注释中以便旧浏览器可以正常工作。

例子 (Example)

<!DOCTYPE html>
<html>
   <head>
      <title>Commenting Style Sheets</title>
      <style>
         <!--
            .example {
               border:1px solid #4a7d49;
            }
         //-->
      </style>
   </head>
   <body>
      <div class = "example">Hello , World!</div>
   </body>
</html>