引用

阿水 的 使用Eclipse生成Java Doc

water.ashui 2009.11.12

所谓的Java Doc就是我们平时进行开发的时候，使用别人已经做好的类库中提供的相关的API的文档。（API：Application Programming Interface ？）

我们知道，在Java中有三类注释，如下：

l         // comment goes here

l         /* comment goes here */

l         /** comment goes here */

前两个具体是用来干什么的，相信已经不用我多说了。这里主要说一下第三个，也就是文档级的注释。

你可以不用去看我写在代码里面的究竟是什么样的方法，而是只用通过我生成的API文档就可以大体的知道我写的代码里面各个方法是干什么用的。

废话不多说，贴一段代码出来就一目了然了。

/**

*

*/

package water.demo.javadoc;

/**

* 类的说明

*

* <p>

* 这里写的东西一般是这个类的说明, 应该包括的东西有<br>

* 这个类的用途以及相关的说明, 作者, 版本 等与这个类<br>

* 有关的东西(如改动的版本记录等)

*

* @author water

* @version 1.0  water 2009.11.12<br>

* 1.1 water 2009.11.12 添加了说明

*/

public class Demo {

/* 对于类公有的属性, 也要写上相关的注释 */

/** 用于显示一个提示信息 */

public final String message = "This is a demo for java doc.";

/**

* 这里写的是方法的说明

*

* 例如, 这个方法是所有Java程序的入口, 在虚拟机载入这个类的时候,<br>

* 将从这个方法开始运行程序

*

* @param args 这里写的是对参数的说明.<br>

* 例如: 此参数中保存的是从命令行中得到的参数集

*/

public static void main(String[] args) {

Demo demo = new Demo();

System.out.println(demo.message);

System.out.println(demo.upcaseMessage());

System.out.println(demo.getChars(2, 6));

}

/**

* 将 message 转换成一个大写字串

*

* @return 转换成大写字串后的 message

*/

public String upcaseMessage(){

return message.toUpperCase();

}

/**

* 从 message 中取指定的子串

*

* @param beginIndex 子串开始的下标

* @param endIndex 子串结束的下标

* @return

*/

public String getChars(int beginIndex, int endIndex){

return message.substring(beginIndex, endIndex);

}

}

先贴个效果出来，再讲怎么样使用Eclipse生成API。

是不是跟平时见过的API是一样的？

下面就开始生成API了。先把程序里面该写注释的地方都写好。（什么地方该写注释，不是这里面要说的东西。）然后是如下图，[菜单][Project][Generate Javadoc]：

会弹出来这么一个对话框：

注意，上面[Javadoc command:]那里，一定要是你的Java目录下面的javadoc.exe那个可执行程序。其它的使用默认值。其实这里直接点[Finish]就可以了。但是我们还是可以看一看Eclipse都给我们提供了些什么样强大的功能。[Next>]。转到下面的对话框：

这个主要用来配置最后的API的外观的。也使用默认就行。[Next>]。

这个是用来配置一些相关的参数的。比如JRE source compatibility（这个是指Java的编译器的版本。比如1.5, 1.6等）。最下面有一个[Open generated index file in browser]。如果想看到生成的API长什么样的，可以勾选。当然也可以不选，之后你可以从文件系统中导航到你保存API的目录。打开下面的index.html也是一样的效果。然后[Finish]。

Java doc就这样华丽的生成了~