在引用外部开发包时关联源码及文档
1、摘要
1.1、不能随意浏览开源文件的源码
很多API或者框架都是开源的,我们在网上可以下载到其源码包。但是我们在做开发的时候,引用的是他们的编译好的class文件,并且被集中打包在JAR包中。当我们浏览这些类库,并试图打开其中的某一个类时,MyEclipse默认给出的是其反编译得出的文件,如下图所示:
如果我们为其中的开源的JAR包指定源文件的话,那我们选中指定的类时,就可以看到其源代码了。
1.2、不能浏览相关类的帮助文档
当我们将鼠标悬停在代码中的某一个类上时,不能看到其简要的文档说明,需要另外查文档,这样也很麻烦。
2、源码文件和帮助文档的关联
2.1、源码文件和帮助文档在哪里
一般而言,正式发布的公用API都含有齐备的文档说明,开源项目还附上了源代码。这里我们以STRUTS2项目为例来说明:
从Struts2官网上下载下来的All包,包含了源代码、文档、JAR包等所有的内容:
http://apache.fayea.com/struts/2.5/struts-2.5-all.zip,我们将压缩包解压之后,可以看到里面包含的内容:
其中apps文件夹包含了所有的struts2的类库文件,docs包含了所有jar包对应的api文档,lib对应了struts2的依赖包,而src文件夹存储了源码文件。我们所要做的就是在MyEclipse中将对应的使用的jar包与相应的源码文件夹和文档文件夹关联起来,这样我们查阅起来就会非常方便了。
2.2、关联源码文件
第一步:选中需要关联源码的JAR包,并单击右键,选中Properties项,如下图所示:
第二步:在弹出的对话框中指定这个包对应的源码包的位置,如下图中红色的方框所示:
struts2-core-2.2.1.jar里面的类的源码在目录struts-2.3.24.1-all/struts-2.3.24.1/src/core/src/main/java下
第三步:选中对话框左侧的Javadoc Location项,指定对应类库的帮助文档的位置:
这里,struts2-core-2.2.1.jar里面的类的帮助文档所在的路径为:struts-2.3.24.1-all/struts-2.3.24.1/docs/struts2-core/apidocs/
最后点击OK保存配置,就可以了
3、查看结果
双击struts2-core-2.2.1.jar包里面的org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter类,我们现在可以看到其源码了:
在编程时使用了StrutsPrepareAndExecuteFilter类,选中此类,然后按F1键,可以打开关于此类的帮助信息:
选中界面中的Javadoc for 'org.apache.struts2.dispatcher.ng.filter.StrutsPrepareAndExecuteFilter.class'项,可以打开其详细的说明文档: