eclipse:WindowBuilder开发时为SWT/JFace引入JavaDoc和源码

版权声明：本文为博主原创文章，转载请注明源地址。 https://cloud.tencent.com/developer/article/1433707

WindowBuilder是一款非常强大易用的java GUI设计工具,可以让程序像使用Visual Studio一样实现对UI的所见即所得(WYSWYG)设计。WindowBuilder原先是google开发的免费软件,现在已经贡献给eclipse.org。关于如何安装WindowsBuilder不是本文的重点，网上可以找到好多关于WindowBuilder安装的教程，我照着教程安装好WindowBuilder后发现代码中引用的SWT/JFace相关的类都没有JavaDoc文档支持。

因为安装WindowBuilder时是不包含SWT/JFace待第三库的JavaDoc的(SWing是JDK自带的，有源码支持)，导致开发过程中要了解相关的类的说明就比较麻烦。如果要在eclipse中加入对SWT/JFace等第三库的JavaDoc和源码支持，有两个解决办法。

方法一：在线JavaDoc

以JFace为例，

如下图，鼠标右键点击你的项目属性，找到Java构建路径，找到org.eclipse.jface.xxxx.jar包,对JavaDoc位置点编辑，

如下图，将如下URL

http://help.eclipse.org/luna/nftopic/org.eclipse.platform.doc.isv/reference/api/

输入JavaDoc URL,点击验证，显示验证有效，就好了。

说明：我的eclipse版本是luna(4.4)，如果是其他版本请将上面URL中的luna换成对应版本的名字

再重新启动eclipse，鼠标移动到相关的类上，就会自动显示JavaDoc内容

方法二:离线JavaDoc

方法一使用在线JavaDoc还是有缺点，对于网络情况不好的环境，获取在线文档就会比较吃力，而且没有源码支持。所以如果能有本地JavaDoc文档，还是首选。

但是eclipse并没有单独为SWT/JFace这些库提供单独的JavaDoc文档下载链接，不过解决的办法总是有的。

Eclipse SDK是eclipse旗下的一个project也是eclipse的基础构件，Eclipse SDK提供了完整的eclipse的所有文档和源(不仅限于SWT/JFace)。

下载Eclipse SDK

打开下面的链接

The Eclipse Project Downloads http://archive.eclipse.org/eclipse/downloads/

根据你的eclipse版本找到相应的链接点击进去，然后下载对应操作系统的Eclipse SDK,大概近200MB。

在下载的zip包中，如下图找到org.eclipse.platform.doc.isv_xxxx.jar，把它单独提取出来。这就是eclipse所有插件的JavaDoc包。

以SWT为例，如下图设置JavaDoc就可以了。

Eclipse SDK中还包括了所有eclipse 插件的源码，所以如果你想查看源码也是可以的，

还以SWT为例，如下图在eclipse SDK的zip包中找到swt对应的源码包(名字包含source的为源码包）

将它单独提取出来，

然后如下图设置源码位置，

设置好之后，点击SWT的任意一个类，就可以查看源码了：

方法三：安装Eclipse SDK插件

方法二要手工设置好多jar的JavaDoc和Source位置。如果你觉得方法二还是太麻烦，那么还有一个更简单的办法，就是在线安装Eclipse SDK插件，

如下图，选择eclipse update site

勾选Eclipse SDK安装插件

安装好Eclipse SDK插件后，所有的eclipse SDK中包含的插件都有了source。

不过如果你需要JavaDoc还是需要手工设置了。如下图，在${eclipse安装目录}/plugins下就可以找到org.eclipse.platform.doc.isv_xxxx.jar,还是比方法二方便，不用从Eclipse SDK zip中提取了。

不过在我这里，在线安装Eclipse SDK插件是个很耗时的任务，我花了差不多两个小时的时间才把它安装好。真不想再装第二次。

参考资料:

http://stackoverflow.com/questions/566877/how-to-get-javadoc-for-swt-and-jface-in-eclipse

http://stackoverflow.com/questions/3700756/where-can-i-download-the-javadoc-for-swtonly