导出java帮助文档

在编写一个项目时，涉及到很多类和方法，对于一些不想看到代码只想知道这个项目有哪些类，这个类有哪些方法以及相应的功能是什么时，就需要用到帮助文档了。所谓的帮助文档就是一个自定义的API。sun公司提供了java整个类库的帮助文档供开发者调用和学习，而我们做的帮助文档则只是用来解释自己项目的API。导出java帮助文档通用的有两种方法：

通过控制台进行相关操作

通过eclipse进行操作

如图，导出后的帮助文档，是一系列html文件：



1.控制台方式

首先通过控制台进入待导出文件的存储位置（我的是在D:/java文件下）：



然后执行导出操作，导出错误或成功时都会有提示，当然常常会遇到因为编码不同带来的问题，只要按控制台提示的错误装换成相应编码即可。



成功后在当前目录得到仪的doc文件夹，打开其中的index.html即可查看帮助文档：



2.eclipse方式

首先File->Export,在弹出的对话框中选择javadoc，点击Next



在新弹出的对话框，选择安装的jdk路径，然后选择要导出帮助文档的工程（当然，也可导出工程中的一个包或者包中的一个类）。

接下来选择要导出的权限，通常是public，因为private本来就是不可见的，如果导出来就没有什么意思了。如果选择private的话，所有属性和方法的说明都会导出。

然后选择导出路径。

完成，收工。

导出结果和控制台完全一样。



当然，如果注释格式不正确，或者编码问题，同样会报错，按要求改正即可。