正确评论HTML标记是精心构建的网页的重要组成部分。这些评论很容易添加,任何人不得不在将来处理该网站的代码(包括您自己或与您合作的任何团队的成员)将感谢您的评论。
如何添加HTML注释
HTML可以使用标准文本编辑器编写,例如Notepad ++ for Windows或TextEdit for Mac。您还可以使用Adobe Dreamweaver等以Web设计为中心的程序,甚至使用Wordpress或ExpressionEngine等CMS平台。无论您使用哪种工具来创作HTML,如果您直接使用代码,您都会添加如下HTML注释:
-
添加HTML注释标记的第一部分:
-
总的来说,您的评论看起来像这样:
-
这真的很简单。
评论的显示
当有人查看网页源或在编辑器中打开HTML进行一些更改时,您添加到HTML代码中的任何注释都将显示在该代码中。但是,当普通访问者访问该网站时,该评论文本不会出现在Web浏览器中。与其他HTML元素(包括段落,标题或列表,实际上影响这些浏览器中的页面)不同,评论实际上是页面的“幕后”部分。
测试目的评论
由于注释不会出现在Web浏览器中,因此它们可用于在页面测试或开发期间“关闭”页面的某些部分。如果您在要隐藏的页面/代码部分之前直接添加注释的开头部分,然后在该代码的末尾添加结束部分(HTML注释可以跨越多行,这样您就可以打开一个评论你的代码的第50行并在第75行关闭它没有问题),然后在该注释中的任何HTML元素将不再显示在浏览器中。它们将保留在您的代码中,但不会影响页面的可视显示。如果您需要测试页面以查看某个部分是否导致问题等,则将该区域注释掉比删除它更可取。使用注释,如果有问题的代码部分证明不是问题,您可以轻松删除注释部分,并再次显示该代码。请确保用于测试的这些注释不会进入生产网站。
如果不应显示页面区域,则需要在启动该站点之前删除代码,而不是仅将其注释掉。
在开发过程中,HTML注释的一个重要用途是构建响应式网站。由于该站点的不同部分将根据不同的屏幕大小(包括可能根本不显示的某些区域)更改其外观,因此使用注释来打开或关闭页面的各个部分可能是在开发过程中使用的快速而简单的技巧。
关于表现
我见过一些网络专业人士建议,应该从HTML和CSS文件中删除评论,以便减少这些文件的大小并创建加载速度更快的页面。虽然我同意页面应该针对性能进行优化并且应该快速加载,但仍然可以在代码中智能地使用注释。请记住,这些注释旨在让以后更容易在网站上工作,因此只要您没有过期,并在代码中的每一行添加注释,就会将少量文件大小添加到网页中评论应该是可以接受的。
使用评论的提示
使用HTML注释时要注意或记住的一些事项:
- 评论可以是多行。
- 使用注释来记录页面的开发。
- 注释还可以记录内容,表格行或列,跟踪更改或任何您想要的内容。
- “关闭”站点区域的注释不应该投入生产,除非此更改是一个临时的,将在短时间内反转(如根据需要打开或关闭警报消息)。