java基础(1)文档注释

1、代码注释：

   // 单行注释
   /* ... */  多行注释
   /** ... */ 文档注释：提供将程序信息嵌入到程序中的功能，可以使用javadoc工具将信息取出，然后转换成html文件，javadoc标记：

 @author         确定类的作者
 @deprecated     指示反对使用这个类或成员
 {@docRoot}      指定当前文档的根目录路径(Java2的1.3版新增)
 @exception      确定一个方法引发的异常
 {@link}         插入对另一个主题的内部链接
 @param          为方法的参数提供文档
 @return         为方法的返回值提供文档
 @see            指定对另一个主题的链接
 @serial         为默认的可序列化字段提供文档
 @serialData     为writeObject()或者writeExternal()方法编写的数据提供文档
 @serialField    为ObjectStreamField组件提供文档
 @since          当引入一个特定改变时，声明发布版本
 @throws         与@exception相同
 @version        指定类的版本

示例：
/**
* This class draws a bar chart.
* @author Herbert Schildt
* @version 3.2
*/

 

2、jsp页面注释（以下1和2同样也适用于.net系列的aspx页面）：

(1)、HTML注释（输出注释）：指在客户端查看源代码时能看见注释。例如，

<!-- this is an html comment.it will show up int the response. -->

(2)、JSP页注释（隐藏注释）：指注释虽然写在JSP程序中，但不会发送给客户，因此在客户端查看源代码时不能看见注释。这样的注释在JSP编译时被忽略掉。

<%--this is a JSP comment.it will only be seen in jsp code--%>

(3)、Java注释：只能出现在Java代码区中，不允许直接出现在页面中,只能使用单行注释和多行注释。