欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页

【转载】JAVA程序员帮助文档查看利器:GroovyHelp GroovyHelpJavadocchmAPI 

程序员文章站 2024-03-14 16:08:46
...

自从开始学java之后,有一件事一直让我很纠结,这就是查看帮助文档不是很方便。java的帮助文档大多是javadoc制作的,通常 提供的是一 个压缩包,里面是一堆网页文件,这种查看方式中搜索功能比较弱,所以很不方便。因此不得不去找一些第三方制作的chm格式的文档,然而,这种文档在 linux系统下查看却又有些不友好。因此,找到一个在windows和Linux都好用的帮助文档成了我最大的愿望。

昨天,照例流量开源社区时,发现了一款名为GroovyHelp的软件,其实在以前逛网站时也多次见到它,但是一直没有在意,昨天点进去看了下详细介绍,没想到这一看让我找到了好宝贝。正所谓好东西不能藏着掖着,得拿出来分享一下,因此,小撰此文推介一下。

GroovyHelp是一款帮助软件,它能够帮助Java开发人员方便快速地查找Javadoc文档并对其进行高效管理,从此无需苦寻chm格式的帮助文档了。

GroovyHelp能够帮助Java开发者快速查阅Javadoc帮助文档,主要特性如下所示(山风小子注: 目前最新特性列表请详见GroovyHelp 3.1.0发布信息 ):
* 根据输入关键字,查找类,接口,方法等帮助信息(支持模糊查询)
* 支持全文检索,并高亮搜索结果(支持模糊查询)
* 以树型结构完整展现文档的整体结构及文件结构
* 支持源码关联,即查看文档所对应的源码,并语法高亮显示源码
* 支持JDK1.4+(包括JDK1.4)自带的Javadoc生成的帮助文档
* 无需解压文档及源码ZIP压缩包,节省磁盘空间
* 用户可以*选择所需的jre1.6.0+(自己安装的jre,或者GroovyHelp提供的jre)

由 于它自身也是由java编写,因此有着java的跨平台特性,我们可以在各个操作系统中使用它。不过在使用过程中有一个需要注意的地方,由于它是 在32位环境下编写的,使用的swt类也是32位的,因此,和我一样的64位用户需要自己去下载swt的64位版,替换应用目录下 lib\endorsed的SWT类。由于只能在eclipse官网上下载,而该文件藏得比较深,这里我提供一个网盘下载:
    swt-3.7-gtk-linux-x86_64.jar:盛大网盘115网盘
    swt-3.7-win32-win32-x86_64.jar:盛大网盘115网盘 山风小子注: 此处“盛大网盘”的地址有点问题,可至swt 3.7 下载页面 下载)

这个应用的使用也是非常简单,解压后在系统环境变量中添加GROOVYHELP_JAVA_HOME,值为jdk所在路径。

【转载】JAVA程序员帮助文档查看利器:GroovyHelp
            
    
    
        GroovyHelpJavadocchmAPI 

启动后点击菜单栏docs中manage docs,选择你需要添加的文档即可,它会自动读取文件名,如果你还需要加上源码查看的话,可以同时添加源码压缩包。建议把文档和源码都置于同一个目录下,方便管理。对了,路径中不能出现中文,否则会有问题。

【转载】JAVA程序员帮助文档查看利器:GroovyHelp
            
    
    
        GroovyHelpJavadocchmAPI 

 

【转载】JAVA程序员帮助文档查看利器:GroovyHelp
            
    
    
        GroovyHelpJavadocchmAPI 

等创建好索引之后就可以在应用中方便的查看、管理文档及源码了,相信它可以给开发者提供最大的帮助吧?

【转载】JAVA程序员帮助文档查看利器:GroovyHelp
            
    
    
        GroovyHelpJavadocchmAPI 

       由 于刚刚开始使用它,还有一些不熟悉,不过在这点时间里,发现了一些比较郁闷的现象。并非所有第三方类库的开发商会提供帮助文件的下 载,通常只提供在线版,这样一来,在断网情况下仍旧无法查看。希望有朝一日有那么一个应用,可以直接将那些帮助文档下载下来,并以一定的格式显示。而像 groovyhelp的文档、源码互相对应方便查看的功能,更可以做成一个上下两个框架同步显示的形式,让用户在查看帮助的同时通过源码进行进一步了解其 操作形式。

       附带说下,虽然应用界面是纯英文的,但是它可是我们国人的杰作哦。

项目地址:http://code.google.com/p/groovyhelp/

原创文章,转载请注明: 转载自网憩阁

本文链接地址: JAVA程序员帮助文档查看利器:GroovyHelp