2.8 HTML网页注释

本节向读者介绍HTML网页中添加注释的使用方法。HTML网页中被注释的内容是不会显示在浏览器中的,这样可以有效地避免页面中想隐藏的内容也被显示出来,这就是注释的功能所在。

在HTML网页中使用注释的优点有很多:比如,为代码添加注释,既可以方便自己后期修改维护,也可以方便其他程序员阅读理解并完善你写的代码。又比如:将暂时不需要执行的代码先注释起来,这样以后想重新恢复代码时就很简单。当然最关键的一点,一段优秀的代码配上合理必要的注释才算完美,这也是一个优秀程序员所必备的良好习惯之一。

如果读者想在HTML网页中使用注释,需要使用“<!-- -->”符号,并遵循下面的写法:

提示

只有上面这种符号对HTML网页代码起注释作用,而像“//”和“/* */”符号也会出现在HTML网页中,但只会对JavaScript脚本代码和CSS样式代码起作用。

下面看一段使用注释的HTML网页代码(参见源代码ch02/ch02-html-comment.html文件)。

【代码2-12】

【代码解析】

第04行代码的注释,说明了下面代码是用于添加头部内容。

第12行代码的注释,说明了下面一段定义CSS样式的代码。

第23行、第26行、第29行和第32行代码后面的CSS注释,使用的是“/* ... */”符号。

第37行脚本代码后面的JavaScript注释,使用的是“// TODO:”符号。

第48行、第50行、第52行、第54行和第56行代码的注释,说明了其后的代码添加了四种不同风格的CSS样式字体。

但第56行代码原本想完成与第48行、第50行、第52行和第54行代码同样的功能,但第56行注释代码中“-->”注释结尾符号没写完整,结果是将第57~60行代码全部注释掉了。

运行测试网页,效果如图2.15所示。由于第56行代码的错误,第57行代码的内容没有显示出来。同时,虽然第57~60行代码也被注释掉了,但并没有影响HTML网页的正常输出。

图2.15 HTML网页注释