大家对java源代码中注释的疑惑,看完就明白了.
Java支持三种形式的注释。前两种是// 和/* */。第三种方式被称为文档注释。它以“/**”开始，以“*”标志结束。文档注释提供将程序信息嵌入程序的功能。开发者可以使用javadoc工具将信息取出，然后转换为HTML文件。文档注释提供了编写程序文档的便利方式。javadoc工具生成的文档几乎人人都看过，因为Sun的Java API文档库就是这么生成的。
javadoc标记
javadoc实用程序识别下列标记：
Tag标记
意义
@author
确定类的作者
@deprecated
指示反对使用这个类或成员
{@docRoot}
指定当前文档的根目录路径 (Java 2的1.3版新增)
@exception
确定一个方法引发的异常
{@link}
插入对另一个主题的内部链接
@param
为方法的参数提供文档
@return
为方法的返回值提供文档
@see
指定对另一个主题的链接
@serial
为默认的可序列化字段提供文档
@serialData
为writeObject( )或者writeExternal( )方法编写的数据提供文档
@serialField
为ObjectStreamField组件提供文档
@since
当引入一个特定改变时，声明发布版本
@throws
与@exception相同
@version
指定类的版本
文档注释的一般形式
在用/**开头后，第一行，或者头几行是类、变量或方法的主要描述。其后，可以包括一个或多个不同的@标记。每个@标记必须在一个新行的开头，或者跟随一个星号(*)。同类型的多个标记应该组合在一起。例如，如果有三个@see标记，最好是一个挨着一个。
下面是一个类的文档注释的例子：
/**
* This class draws a bar chart.
* @author Herbert Schildt
* @version 3.2
*/
javadoc的输出
javadoc程序将Java程序的源文件作为输入，输出几个包含该程序文档的HTML文件。每个类的信息在其自己的HTML文件中。同时，javadoc还输出一个索引和一个层次结构树。Javadoc还可生成其他HTML文件。不同实现版本的javadoc可能工作方式有所不同，应该仔细阅读Java开发系统的说明书以了解此版本的细节处理。