5.4.2 JSP注释
在JSP程序中加入注释是一种良好的编程习惯,可以增强程序的可读性,易于维护。由于JSP代码中包含了多种语言,所以在JSP中可以使用很多种类型的注释,如HTML中的注释、Java中的注释和在严格意义上说属于JSP页面自己的注释:带JSP表达式的注释和隐藏注释。它们的语法规则和运行效果有所不同。
1.HTML中的注释
HTML中的注释语法格式如下:
!--注释 --
因为JSP页面通常由HTML标记和嵌入的Java程序片段组成,所以在HTML中的注释同样可以在JSP中使用。由这种方法产生的注释会通过JSP引擎发送到客户端,但不直接显示,仅在源代码中可以查看到。
【例5-5】HTML中的注释。
运行效果如图5-6所示。
图5-6 HTML注释的运行效果
2.带JSP表达式的注释
在HTML注释中可以嵌入JSP表达式,语法格式如下:
!--注释%=表达式%--
包含该注释语句的JSP页面被请求后,服务器会识别并执行注释中的JSP表达式,对注释中的其他内容不做任何操作。当服务器将执行结果返回给客户端后,客户端浏览器会识别该注释语句,注释的内容同样不会显示在浏览器中。
【例5-6】带JSP表达式的注释。
运行效果如图5-7所示。
图5-7 带JSP表达式的注释运行效果
3.隐藏注释
前面介绍的HTML注释虽然在客户端浏览页面时不可见,但用户一旦查看源代码就会看到这些注释。所以严格来说,这种注释并不安全。下面将介绍一种隐藏注释,语法格式如下:
%--注释--%
使用该方法注释的内容,不仅在客户端浏览时看不到,在客户端查看HTML源代码也不会看到,所以安全性较高。
【例5-7】使用了隐藏注释,如图5-8、图5-9所示,在浏览器和客户端显示的源代码中均无法看到“本行注释未显示,在客户端查看源代码亦不可见”这段内容。
【例5-7】隐藏注释。
运行结果如图5-8所示。
图5-8 带隐藏注释的页面在浏览器上显示的效果
图5-9 查看源代码的效果
4.脚本程序中的注释
在脚本程序中的注释和在Java中的注释是相同的,包括下面3种注释方法。
(1)单行注释
单行注释的格式如下:
//注释内容
符号“//”后面的所有内容为注释的内容,服务器对该内容不进行任何操作。因为脚本程序在客户端通过查看源代码是不可见的,所以在脚本程序中通过该方法被注释的内容也是不可见的。
(2)多行注释
多行注释是通过“/*”与“*/”符号进行标记的,它们必须成对出现,在它们之间输入的注释内容可以换行。多行注释的格式如下:
多行注释和提示文档进行注释的内容都是不可见的。