文档介绍：J avaDOC 文档和 javadoc javadoc 标记 1.***@see 的使用 ***@author 、***@version 说明类 ***@param 、***@return 和***@exception 命令前言 Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种? //注释一行/*...... */注释若干行不完全对,除了以上两种之外,还有第三种,文档注释: /** ...... */注释若干行,并写入 javadoc 文档通常这种注释的多行写法如下: /** *......... *......... */ 一. Java 文档和 javadoc Java 程序员都应该知道使用 JDK 开发,最好的帮助信息就来自 SUN 发布的Java 文档。它分包、分类详细的提供了各方法、属性的帮助信息,具有详细的类树信息、索引信息等,并提供了许多相关类之间的关系,如继承、实现接口、引用等。 Java 文档全是由一些 html 文件组织起来的,在SUM 的站点上可以下载它们的压缩包。但是你肯定想不到,这些文档我们可以自己生成。安装了 JDK 之后,安装目录下有一个 文件或者 文件,它们都是以 ZIP 格式压缩的,可以使用 WinZip 解压。解压之后, 文件。是了,这些就是 Java 运行类的源码了, 非常完整,连注释都写得一清二楚……不过,怎么看这些注释都有点似曾相识的感觉? 这就不奇怪了,我们的迷底也快要揭开了。 源文件中的文档注释(/** ... */)和Java 文档的内容,你会发现它们就是一样的。Java 文档只是还在格式和排版上下了些功夫。再仔细一点, 源文件中的注释还带有 HTML 标识,如<B> 、<BR> 、<Code> 等,在 Java 文档中,该出现这些标识的地方,已经按标识的的定义进行了排版。终于真像大白了,原来 Java 文档是来自这些注释。难怪这些注释叫做文档注释呢!不过,是什么工具把这些注释变成文档的呢? 是该请出 javadoc 的时候了。在JDK 的bin 目录下你可以找到 javadoc , 如果是 Windows 下的 JDK ,它的文件名为 。使用 javdoc 源文件时, 源文件中的文档注释,并按照一定的规则与Java 源程序一起进行编译,生成文档。介绍 javadoc 的编译命令之前,还是先了解一下文档注释的格式吧。不过为了能够编译下面提到的若干例子,这里先介绍一条 javadoc 命令: javadoc -d文档存放目录-author -version 这条命令编译一个名为“ ”的java 源文件,并将生成的文档存放在“文档存放目录”指定的目录下,生成的文档中 就是文档的首页。-author 和-version 两个选项可以省略。二. 文档注释的格式文档注释可以用于对类、属性、方法等进行说明。写文档注释时除了需要使用/** .... */限定之外,还需要注意注释内部的一些细节问题。 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。比如,需要换行时,不是敲入一个回车符,而是写入<br> ,如果要分段,就应该在段前写入<p> 。因此,格式化文档,就是在文档注释中添加相应的 HTML 标识。文档注释的正文并不是直接复制到输出文件(文档的 HTML 文件),而是读取每一行后,删掉前导的*号及*号以前的空格,再输入到文档的。如/** *This isfirst line. <br> ***** This issecond line. <br> This isthird line. */编译输出后的 HTML 源码则是 This isfirst line. <br> This issecond line. <br> This isthird line. 前导的*号允许连续使用多个,其效果和使用一个*号一样,但多个*号前不能有其它字符分隔,否则分隔符及后面的*号都将作为文档的内容。*号在这里是作为左边界使用,如上例的第一行和第二行;如果没有前导的*号, 则边界从第一个有效字符开始,而不包括前面的空格,如上例第三行。还有一点需要说明,文档注释只说明紧接其后的类、属性或者方法。如下例: /** comment for