什么是HTML评论以及如何使用它们
a当您在浏览器中查看网页时,您会看到基于特定网页的代码显示该软件(网络浏览器)显示的内容。 如果您查看网页的源代码 ,您将看到由各种HTML元素组成的文档,其中包括段落,标题,列表,链接,图像等。 所有这些元素都由浏览器在访问者的屏幕上呈现,作为网站显示的一部分。 在HTML代码中可以找到的一件事情,不是在人物屏幕上呈现的,就是所谓的“HTML注释”。
什么是评论?
评论是HTML,XML或CSS中不被浏览器或解析器查看或执行的代码串。 它只是写入代码中以提供有关该代码的信息或来自代码开发人员的其他反馈。
大多数编程语言都有注释,它们通常被代码开发人员用于一个或多个,原因如下:
- 向将来可能需要处理的人描述并解释复杂的代码 - 包括他们自己! 他们可能会在12个月或更长时间后回到代码3或6,并不记得他们为什么以某种方式做了某些事情。 评论可以帮助回答他们的问题,并提醒他们当他们第一次开发该页面时他们的头脑在哪里。
- 提供关于何时编辑或审查代码的详细信息。 这可能是有用的信息,有点像一个网站上次工作时的开发日志。
- 删除部分代码,但将它们留出供以后使用。 这通常在现场测试和调试期间完成。 如果您在网站上遇到问题并且不确定是什么导致了问题,那么您可以逐个注释第一部分,以确定问题,然后针对您遇到的任何问题解决问题。
- 与其他开发代码的开发人员聊天。 这可能会在开发过程中完成,以便与同时处理代码的其他人共享详细信息。 如果这些评论纯粹是开发性对话,那么在网站推出之前将其从代码中移除是最佳做法。
传统上,HTML中的评论几乎用于任何元素,从复杂表格结构的解释到页面本身内容的信息性评论。 由于评论不是在浏览器中呈现的,您可以将它们添加到HTML中的任何位置,并且不用担心客户查看网站时将执行的操作。
如何撰写评论
用HTML,XHTML和XML编写评论非常简单。 简单地将您想要注释的文字置于以下位置:
<! -和
- >正如你所看到的,这些评论以“小于符号”开头,加上一个感叹号和两个破折号。 评论以两个破折号和一个“大于:符号结束。在这些角色之间,你可以写任何你想要组成评论主体的东西。
在CSS中,它有点不同,使用C代码注释而不是HTML。首先使用正斜杠,后跟星号。 您可以用相反的方式结束评论,星号后跟正斜杠。
/ *评论文字* /评论是一个垂死的艺术
大多数程序员知道有用评论的价值。 评论代码使代码从一个团队成员转移到另一个团队成员更容易。 评论可以帮助你的QA团队测试代码,因为他们可以告诉开发者的意图 - 即使它没有实现。 不幸的是,随着Wordpress等网站创作平台的流行,它允许您启动并运行一个选定的主题,为您处理HTML(如果不是全部)HTML,因此Web团队不会经常使用评论。 这是因为如果您不直接使用代码,那么在大多数可视化创作工具中,评论真的很难看到。 例如,而不是在网页的顶部看到:
<! - 不要编辑本页,它是由脚本自动生成的 - >可视化工具显示一个小图标来表明有评论。 如果设计师没有实际打开评论,他可能永远都看不到它。 在上述页面的情况下,如果她编辑页面并且该评论中提到的脚本覆盖了该编辑,则可能会导致问题。
可以做什么?
- 写出有意义且有用的评论。 不要指望其他人阅读你的评论,如果他们太长或没有包含有用的信息。
- 作为开发人员,您应该始终查看您在页面上看到的任何评论。
- 使用允许您添加评论的创作程序提供的工具。
- 使用内容管理来控制页面的编辑方式。
即使你是唯一编辑你的网页的人,评论也是有用的。 如果您每年只编辑一个复杂页面,很容易忘记您如何构建表格或将CSS放在一起。 有了评论,你不必记住,因为它是为你写的。
Jennifer Krynin的原创文章。 在5/5/17由Jeremy Girard编辑