当前位置:首页 > 开发 > 编程语言 > Eclipse > 正文

在Eclipse中加入jar包的javadoc或者源代码

发表于: 2013-04-23   作者:stdayong   来源:转载   浏览:
摘要: 动机:在使用Eclipse做程序的时候,如果有程序的源代码,那么在调用别人的方法的时候,会把方法的形参作为默认的参数,如ConstanceAggregateFacade.getConstanceAggregate(constanceId);但是,如果没有的话,就会变成arg0,如ConstanceAggregateFacade.getConstanceAggregate(arg0)。虽然,这样看似
动机:在使用Eclipse做程序的时候,如果有程序的源代码,那么在调用别人的方法的时候,会把方法的形参作为默认的参数,如ConstanceAggregateFacade.getConstanceAggregate(constanceId);但是,如果没有的话,就会变成arg0,如ConstanceAggregateFacade.getConstanceAggregate(arg0)。虽然,这样看似乎没有多大的区别,但是有很多缺点:1、增加了程序员无谓的工作量;2、如果参数很多,而且类型相同的话,单纯的arg0、arg1、arg2、arg3...增加了出错的几率。因此,准备解决一下这个问题。这对Facade类尤为重要。

1、使用javadoc。
1.1、生成javadoc。在Eclipse的Project菜单上,点Generate javadoc。一路next下去,注意在最后需要指定生成的编码(-encoding UTF-8 -charset UTF-8)。会在指定的文件夹下生成一些html。
1.2、将javadoc打包。把生成的文件夹打包成ZIP文件。注意,index.html文件必须在包的最外层,不能有多余的文件夹结构。
具体操作:到要打包的文件夹里面,选择所有的文件和文件夹,然后压缩;而不是直接在父文件夹上压缩。
1.3、将生成的javadoc指定到jar包上。在Package Explorer视图中,选择jar包。右键单击Properties,在Properties中找到指定javadoc的页。如果想指定到文件夹,则选用URL方式;如果想指定到ZIP包,则选择用archive方式。
至此,我们已经可以使用这个jar包的javadoc了。具体有两个用途,首先保证了调用方法的形参,其次可以在javadoc视图中看到类、方法、属性的javadoc。这里已经可以圆满的解决参数的形参问题了。
在使用的时候,还有非常棘手的乱码问题,不光光是要设置project的编码,还要设置workspace的编码。具体做法是,首选项>>Workspace>>Text file encoding。
1.4、额外的,可以把javadoc打成chm。使用“powerCHM 中文”,但是生成的有一些网页是乱码,似乎解决不了。


2、使用源代码。
javadoc就是源代码中抽取出来的。因此,使用源代码可以解决使用javadoc的所有问题。即参数的形参和查看javadoc。
只需要简单的说明源代码的打包。同javadoc的打包,不能有多余的文件夹结构。包的顶层就是com、org等package。

至此,我们可以看到,在真正发布一个开源项目项目的时候。要制作:jar包、lib包、源代码、javadoc,如果需要的话,还要做上fat jar包。



转自:http://blog.csdn.net/lihaifeng555/article/details/6887397

在Eclipse中加入jar包的javadoc或者源代码

  • 0

    开心

    开心

  • 0

    板砖

    板砖

  • 0

    感动

    感动

  • 0

    有用

    有用

  • 0

    疑问

    疑问

  • 0

    难过

    难过

  • 0

    无聊

    无聊

  • 0

    震惊

    震惊

版权所有 IT知识库 CopyRight © 2009-2015 IT知识库 IT610.com , All Rights Reserved. 京ICP备09083238号