如何使用Javadoc生成api文档

1、在这里我以MyEclipse开发工具为例子。打开MyEclipse并新建一个项目。在项目下新建一个包，包名自己随便取即可。

2、在包里面需要新建一个类，这里以Test的例子为示例。其中注释的方法是“/**”然后敲回车。

3、这里的“@”是一种注释方式，其他的注释还有：

@author 标明开发该类模块的作者

@param 标明参数

@version 标明该类模块的版本

@see 参考转向，也就是相关主题

@throws 表示抛出异常描述

@param 对方法中某参数的说明

@return 对方法返回值的说明

@exception 对方法可能抛出的异常进行说明

@deprecated 表示废弃。这里不建议使用

4、我在这里只是演示了“@author”和“@verson”两个，大家有兴趣的可以去探究下其他的几个方法。

5、右键项目，选择Export.

6、选择java文件夹，点击java文件夹下面的Javadoc，然后点击“Next”。

7、选择你要生成的java项目。并更改你想保存的API文件地址。点击“Finish”。

8、点击“Finish”之后会有提示，只需要点击“Yes To All”即可。

9、打开你保存的文件夹，你会发现有很多生成的文件，那么应该点击那个一呢？聪明的你一定能猜到“index.html”双击打开它。

10、打开之后会看到如下界面，是不是很熟悉？没错，与java相关的很多API都是这样子的。

11、我们打开我们建立的这个“Test”的类可以看到这个类里面的注释和方法。都是我们自己编写的。是不是很神奇？有没有一种成就感？

12、以上就是简单建立一个API，在以后的工作中，我们不仅仅是要编写注释，有时候还需要编写API来给其他开发人员看。