使用Javadoc命令获取开源框架或者库的文档

Java平台有个特点，那就是各种库，框架特别多，学习的过程中，各种库和框架的学习是必不可少的，但是很多苦，很少可以找到学习教程或者教材，这种时候，文档就是最好的学习工具了。但是很多时候，这些框架或者库的文档也不是那么好找，但是，如果我们拥有框架或库的源代码，就可以很方便的使用sun提供的工具Javadoc来生成文档。

关于Java中的注释规范，相信大家都是清楚的，什么样子的注释可以被Javadoc识别并生成文档，我这里就不赘述了。

Javadoc的命令格式如下

javadoc [选项] [软件包名称] [源文件] [@file]

Javadoc命令怎么用相信大家已经知道了，百度上很多，我这里只说一下怎么快速的打包多个代码包

方法一：

在包不是很多的情况下，可以使用@file参数

比如有三个包放在同一个目录下

Java.lang

Java.net

Java.net

这个时候，我就可以在这个目录下建一个文件package.txt

内容如下

Java.lang

Java.math

Java.net

然后我们把这三个包的文档打包到api文件夹下

我们就可以输入命令

Javadoc -d api @package.txt

这种方法只适合一些包不是很多情况，当然，如果是一个成熟的框架，通常有成百上千个包，这种方法就不合适了。但是@参数有一个很大的好处就是，可以把具体要打包的内容和命令分离开来，这样可以写个小工具，以后可以很方便的使用。

方法二：使用-subpackages参数

其实我们可以把java.long java.math java.net 理解为java包下面的子包，只要对java包递归的打包就可以了，这样我们就可以用-subpackages参数，让javadoc递归的生所有子包的文档。

我用javadoc命令导出了eclipse swt 框架的文档

源代码是以org开始的一系列文件夹，命令如下

Javadoc -d api -subpackages org

我让javadoc对org包递归的导出文档就可以了

这两种方法可以结合在一起使用。Javadoc还有很多很强大的功能，键入javadoc，控制台就会打印出帮助的。