如何在HTML中添加注释

使用 HTML 进行编码时,编写注释是一种很好的做法。那么,如何在 HTML 中添加注释呢?在编写软件文档时,在代码中添加注释至关重要。评论在网页上不可见,因为它们不是针对读者的。

如何在HTML中添加注释-南华中天

浏览器会忽略评论标签之间的任何文本,因此不会显示在网络上。用于注释的 HTML 用于解释代码。编写代码注释的目的是使代码具有可读性,并根据不同部分的作用来解释代码。用户经常使用注释来监控代码行。当开发人员社区致力于单个项目时,HTML 注释会派上用场。它们的作用主要是促进交流。

HTML注释 有四种类型。

1. 单行注释 

用户可以对单行进行评论。请注意,单行注释以特殊箭头 <!--- 注释---> 开头。然后编译器会忽略正斜杠和行尾之间的内容。

在代码行之前使用单行注释的示例如下:

<! --- code comment---> < Users can comment on single lines> 

以下是在代码行末尾使用的注释示例:

< Users can comment on single lines><! --- code comment--->. 

2.多行注释 

用户还可以在多行上使用 HTML 注释代码。尽管如此,评论仍然没有显示。只有代码行将在输出中。

3. HTML 注释标签  

您可以使用 <comment> 向代码添加注释。但是,请注意,这通常可以通过 Internet Explorer 实现。

4. 有条件的评论  

这些注释用于执行具有设定条件的特定代码。Internet Explorer 支持像 <comment> 标签这样的条件注释。

虽然没有具体的评论使用指南,但不同的开发者有自己的偏好。本质上,注释用于:

  1. 解释编写代码的原因。
  2. 突出显示代码的结果。
  3. 使代码行更清晰。

用户还应注意,评论的使用不仅限于上述三种情况。有更多的方法可以使用它们。

通常,程序员在调试期间使用注释。他们使用注释来请求浏览器忽略代码而不必消除它,因为他们诊断问题的原因并尝试排除故障。

仅当它们为程序创造价值时才使用 HTML 注释。开发人员不需要解释程序中代码的每一个功能。他们还应该了解向 HTML 添加注释的最佳实践,例如不向明显的事物添加注释。请注意,过度使用注释可能会分散主代码的注意力。

用户也不应重述现有代码。请记住,注释用于阐明代码中的逻辑。不要用它们来说明已经写在代码行中的内容。如果可能,开发人员需要避免长注释。如果他们觉得需要很长的评论来解释复杂的功能,他们可以选择文档条目。

虽然评论不会在网站上呈现,但如果您将文档公开,任何人仍然可以在互联网上访问它们。他们可以帮助您跟踪和监控代码,即使在几个月没有工作的情况下也是如此。他们还支持与其他开发人员的沟通。

注释有两个主要好处,使您的代码易于理解并跟踪代码的不同部分。

开发人员使用 HTML 注释来增加代码的可读性、调试、帮助其他人揭开他们的代码的神秘面纱以及标记结束标记。除了上述原因之外,这就是您应该避免使用 HTML 注释的原因。

1.会影响用户体验 

您可能想知道 HTML 评论如何影响性能,但评论并未呈现在网站上。

请注意,注释仍然是文档对象模型 (DOM) 的一部分。这会增加 DOM 元素,从而影响网页的响应性。它还会影响速度,表现为对 DOM 和 CSS 选择器的缓慢操作。

2.它会伤害你的SEO 

过多的 HTML 评论会影响您的 SEO,但不会影响关键字或内容排名。评论被浏览器忽略并且不计入排名。但是,它们会影响您的页面加载速度。

评论过多会增加文档和网页的大小(以字节为单位)。这将影响页面加载时间,对您的排名产生负面影响。请注意,如果加载时间超过 3 秒,用户将在点击后退出页面,导致跳出率较高。高跳出率对网站来说是一个负面信号,因为它发送的信息是该页面对访问者没有帮助。

太多的评论也会损害文本与 HTML 的比例。应保持 25% 到 70% 之间的良好文本与 HTML 比率。该比率表示可见内容的百分比。请注意,搜索引擎会为具有大量可见内容的网站提供高排名。

3.带宽损失 

大型 HTML5 评论内容会导致带宽使用量激增。拥有更多字节会导致流量显着增加。

如果以正确的方式和数量使用 HTML 注释,则对开发人员很有用。通过使用它们,您可以使您的代码更易于理解。那是给任何可以打开你的源代码的人。

如果您正在与其他开发人员团队一起开发一个项目,这些评论可以帮助您保持在同一页面上并使协作变得容易。上面的信息为您提供了有关如何在 HTML 中添加注释的指导性基础知识,包括它们是什么、如何使用它们、何时使用它们、开发人员为什么使用它们以及何时应该避免它们。