`

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

阅读更多
动机:在使用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包源码

    "eclipse中反编译jar包源码"这个主题涉及到如何在Eclipse集成开发环境中使用特定的插件和工具来查看.jar文件的源代码。 首先,我们来看一下标签"jad",它是Java反编译器JAD的简称。JAD是一款流行的Java字节码到源...

    Eclipse中设置中文件javadoc

    它可以将Java源代码中的注释和说明转换为HTML格式的文档,从而方便开发者了解Java类、方法和变量的使用说明。javadoc是Java开发中的一个重要工具,它可以帮助开发者快速了解Java类库中的类、方法和变量的使用说明。 ...

    Android.jar包的源码查看,并加入到Eclipse中

    在Eclipse中集成`Android.jar`的源码,可以方便地在调试过程中查看源码。以下是集成步骤: 1. 在Eclipse中,右键点击项目,选择"Properties"。 2. 在左侧导航栏中选择"Java Build Path",然后转到"Libraries"标签页...

    jfreechart-1.0.14 库文件,源代码(src)及javadoc文件

    例如,在 Eclipse 中,右键点击 jar 文件,选择“属性”,然后在“Java”选项卡中添加到构建路径,同时可以勾选“包含源代码”和“包含 javadoc”。 JFreeChart 库的广泛应用体现在数据分析、报表系统、监控界面等...

    eclipse安装反编译所需的jar包和可执行程序

    在IT行业中,有时候为了理解和学习某个Java库的功能或者查找bug,我们需要查看其源代码,但很多jar包并不提供源码。这时,反编译技术就显得尤为重要。本教程将指导你如何在Eclipse环境中安装反编译所需的jar包和可...

    jad在Eclipse配置查看jar包源码配置步骤

    关闭窗口后,当你在代码中引用到jar包中的类时,Eclipse会自动显示jad反编译的源码。 5. 实时查看:如果你的项目引用了Maven或Gradle,可以配置相应的构建工具,使其在构建过程中自动下载源码。对于Maven,可以在...

    eclipse,myeclipse 查看jar包源代码

    下面我们将详细探讨如何在这些IDE中查看jar包的源代码,以及这样做的重要性和具体步骤。 首先,查看jar源码对于开发者来说至关重要。它可以帮助我们理解库或框架的功能,调试代码,学习最佳实践,甚至定位并修复...

    看jar的代码

    尽管`JAR`文件默认不包含源代码,但如果我们有对应的源码或者`JAR`文件包含了`SourceForge`或`Javadoc`信息,那么我们可以通过特定工具查看这些源代码。 查看`JAR`文件源代码的步骤通常如下: 1. **使用反编译器**...

    org.eclipse.jgit-5.10.0.202012080955-r-API文档-中文版.zip

    赠送源代码:org.eclipse.jgit-5.10.0.202012080955-r-sources.jar; 赠送Maven依赖信息文件:org.eclipse.jgit-5.10.0.202012080955-r.pom; 包含翻译后的API文档:org.eclipse.jgit-5.10.0.202012080955-r-javadoc...

    Eclipse中文语言包安装和设置中文

    - 在“rt.jar”包上选择“源代码链接”->“源代码附件”,指向JDK安装根目录下的`src.zip`文件。 ##### 2. 添加中文JavaDoc链接 - 同样在“rt.jar”包上选择“javadoc位置”->“javadoc位置”,指向下载好的中文...

    JUnit4.12及javadoc、sourcecode jar包

    9. **javadoc和sourcecode jar包**:提供的javadoc.jar文件包含了JUnit 4.12的API文档,可以帮助开发者了解各种类和方法的详细说明。sourcecode.jar则包含了源代码,对于学习和调试非常有用。 10. **集成开发环境...

    eclipse-collections-7.1.2-API文档-中文版.zip

    赠送源代码:eclipse-collections-7.1.2-sources.jar; 赠送Maven依赖信息文件:eclipse-collections-7.1.2.pom; 包含翻译后的API文档:eclipse-collections-7.1.2-javadoc-API文档-中文(简体)版.zip; Maven坐标:...

    eclipse导出可运行的jar文件

    - “Packaging options” 部分提供了更多的自定义选项,如是否包含源代码、Javadoc 文档等。 5. **包含第三方类库**: - 在 “Libraries” 选项卡中,勾选 “Pack required libraries into generated JAR” 复选...

    dt-rt-tools的jar包

    标题中的"dt-rt-tools的jar包"提及了三个重要的Java类库文件:dt.jar、rt.jar和tools.jar。这些文件在Java开发中扮演着核心角色,尤其对于JDK(Java Development Kit)的使用者来说至关重要。 1. **dt.jar**: "dt...

    com.cb.eclipse.folding_1.0.6.jar

    代码折叠是指在源代码编辑器中,将不常查看或暂时不需要关注的部分代码区域进行收起,只显示关键部分,这样可以减少屏幕上的视觉干扰,使得主要的代码逻辑更为突出。在Eclipse中,用户可以对类、方法、注释甚至大...

    org.eclipse.jgit.lfs-5.10.0.202012080955-r-API文档-中文版.zip

    赠送源代码:org.eclipse.jgit.lfs-5.10.0.202012080955-r-sources.jar; 赠送Maven依赖信息文件:org.eclipse.jgit.lfs-5.10.0.202012080955-r.pom; 包含翻译后的API文档:org.eclipse.jgit.lfs-5.10.0....

    James开发所需jar包

    在IDE如Eclipse或IntelliJ IDEA中,可以通过设置项目构建路径来添加jar包。 6. **优化和打包**: 对于最终部署,开发者可能需要将所有依赖打包成一个可执行的jar,这通常通过构建工具的“fat jar”或“uber jar”...

    org.eclipse.jdt.core_3.6.0.v_A58.jar

    1. 编译器:JDT Core中的Java编译器是基于ANTLR(ANother Tool for Language Recognition)的,能够解析和理解Java源代码,生成字节码,进行类型检查和错误报告。它还支持Javadoc的生成以及遵循Java语言规范的新特性...

    java常用jar包

    4. **jdtcore-3.1.0.jar**:这是Eclipse Java Development Toolkit (JDT)的核心组件,它包含了用于编译、解析和操作Java源代码的工具。这个jar包对于那些需要在自己的应用中集成类似功能的开发者非常有用。 5. **...

Global site tag (gtag.js) - Google Analytics