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