Javadoc在Eclipse中的配置和使用

1.获得Javadoc工具

Javadoc是JDK自带工具，可通过下载并安装JDK获得。Javadoc工具即位于JDK安装目录的bin子目录下，一般默认路径为C:\Program Files\Java\jdk1.7.0_07\bin。

2.让Javadoc成为Windows命令行

如果希望在Windows的命令行窗口中使用Javadoc，首先必须使系统能够找到Javadoc 的保存路径，这需要配置系统的配置参数，Win7中的配置方法如下。

●Win7中鼠标右键单击桌面上的“计算机”快捷图标，并在弹出的快捷菜单中选择【属

性】菜单，弹出“控制面板\所有控制面板项\系统”窗口。

●在“系统”窗口左侧选择【高级系统设置】菜单，进入“系统属性”窗口。

在“系统属性”窗口中选择“高级”标签页，并点击【环境变量】按钮，进入“环境变量”窗口。

●在“环境变量”窗口中下面的“系统变量”列表框中，通过滚动条找到“Path”变量，

并双击该条目，进入“Path”变量编辑窗口。

●在“编辑系统变量”窗口中，在“变量值”窗口中将光标移到最后，并在后面增加“;Javadoc

路径”，我的电脑配置为“原Path内容;C:\Program Files\Java\jdk1.7.0_07\bin”。

●然后一路确定，启动命令行窗口，在命令行窗口中键入“Javadoc - help”看看，搞定。

3.在Eclipse中使用Javadoc

上面讲述了在Windows中使用Javadoc的方法，在Eclipse中能直接使用吗？这样不是更方便吗？答案是肯定的。

Eclipse中使用Javadoc有三个常见的入口：

（1）File —> Export —> java —>javadoc

（2）Project —> Generate Javadoc

（3）在工程上右键—> Export —> java —>javadoc

三个入口殊途而同归，进入javadoc generation界面。之后你必须要做的事情有：Configure，即找到javadoc.exe的路径，在JDK安装目录的bin子目录下，我的是“C:\Program Files\Java\jdk1.7.0_07\bin”。选择要生成javadoc的工程，选择你要输出的位置，默认输出到工程下的doc文件夹下面。之后的步骤都是可选的，这里有一个要说明的问题：字符集。

在Extra javadoc option中可以设置：

-encoding UTF-8 //-encoding charsetName是指源文件编码

-charset UTF-8 //-charset charsetName用于跨平台查看文档的字符集，它对应着你生成的html文件中的头部的charset

点击【Finish】按钮，然后就可以看到生成的文档了，文档位置就在上一步设定的文档位置，DOC目录下的index.html，可通过浏览器查看生成的项目文档。

如果想了解更多的javadoc的选项：进入命令行，输入：javadoc -help，如果你的环境变量配置的正确的话（参见本篇标题2中的内容），你可以看到全部的选项，这些选项在eclipse 中都可以使用的。

javadoc在命令行中的用法是：

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

具体的使用，自己尝试体会吧。