5.4 JSP注释
由于JSP页面由HTML、JSP、Java脚本等组成,所以在其中可以使用多种注释格式,本节将对这些注释的语法进行讲解。
5.4.1 HTML中的注释
HTML语言的注释不会被显示在网页中,但是在浏览器中选择查看网页源代码时,还是能够看到注释信息的。其语法格式如下:
//注释文本
【例5.16】 在HTML中添加注释。
//显示数据报表的表格 <table> ... </table>
上述代码为HTML的一个表格添加了注释信息,其他程序开发人员可以直接从注释中了解表格的用途,无须重新分析代码。在浏览器中查看网页代码时,上述代码将完整地被显示,包括注释信息。
5.4.2 带有JSP表达式的注释
在JSP页面中可以嵌入代码片段,在代码片段中也可加入注释。在代码片段中加入的注释同Java的注释相同,同样也包括以下3种情况。
1.单行注释
单行注释以“//”开头,后面接注释内容,其语法格式如下:
//注释内容
【例5.17】 在代码片段中加入单行注释的几种情况。
在上面的代码中,通过单行注释可以让语句“System.out.println("您好!" + username);”不执行。
2.多行注释
多行注释以“/*”开头,以“*/”结束。在这个标识中间的内容为注释内容,并且注释内容可以换行。其语法格式如下:
为了程序代码的美观,习惯上在每行注释内容的前面加上一个“*”号,构成以下的注释格式:
/* * 注释内容1 * 注释内容2 * ... */
【例5.18】 在代码片段中添加多行注释的代码如下:
<% /* * function:显示用户信息 * author:wgh * time:2009-10-21 */ %> 用户名:无语<br> 部 门:Java Web部门 <br> 权 限:系统管理员
说明
服务器不会对“/*”与“*/”之间的所有内容进行任何处理,包括JSP表达式或其他的脚本程序。并且多行注释的开始标记和结束标记可以不在同一个脚本程序中同时出现。
3.提示文档注释
提示文档注释会被Javadoc文档工具生成文档时读取,文档是对代码结构和功能的描述。其语法格式如下:
同多行注释一样,为了程序代码的美观,也可以在每行注释内容的前面加上一个“*”号,构成以下的注释格式:
说明
提示文档注释方法与多行注释很相似,但细心的读者会发现它是以“/**”符号作为注释的开始标记,而不是“/*”。与多行注释一样,被“/**”和“/*”符号注释的所有内容,服务器都不会做任何处理。
提示文档注释也可以应用到声明标识中,例如,下面的示例就是在JSP中添加文档注释。
【例5.19】 在代码片段中添加多行注释的代码如下:
在Eclipse中,将鼠标移动到count()方法上时,将显示如图5.6所示的提示信息。
图5.6 显示的提示信息
5.4.3 隐藏注释
通过在文档中添加的HTML注释虽然在浏览器中不显示,但是可以通过查看源代码看到这些注释信息。所以严格来说,这种注释是不安全的。不过JSP还提供了一种隐藏注释,这种注释不仅在浏览器中看不到,而且在查看HTML源代码时也看不到,所以这种注释的安全性比较高。
隐藏注释的语法格式如下:
<%-- 注释内容 --%>
【例5.20】 在JSP页面中添加隐藏注释。(实例位置:资源包\TM\sl\5\4)
编写一个名称为index.jsp的文件,在该页面中,首先定义一个HTML注释,内容为“显示用户信息”,然后再定义由注释文本和JSP表达式组成的HTML注释语句,最后再添加文本,用于显示用户信息。index.jsp文件的代码如下:
运行程序,将显示如图5.7所示的结果。
图5.7 页面运行结果
页面运行后,选择“查看”→“源文件”命令,将打开如图5.8所示的HTML源文件。在该文件中,将无法看到添加的注释内容。
图5.8 查看HTML源代码的效果
说明
JSP编译时会忽略隐藏注释,所以即使隐藏注释中存在语法错误,也不影响程序的运行。
5.4.4 动态注释
由于HTML注释对JSP嵌入的代码不起作用,因此可以利用它们的组合构成动态的HTML注释文本。
【例5.21】 在JSP页面中添加动态注释。示例代码如下:
<!-- <%=new Date()%> -->
上述代码将当前日期和时间作为HTML注释文本。