如何让Eclipse在我的类中显示javadoc而不在jar中包含源代码

时间:2009-05-25 18:30:44

标签: java eclipse javadoc

我正在构建我想要在没有源代码的情况下打包它们的jar,但我希望javadoc能够在eclipse中为开发人员提供。

5 个答案:

答案 0 :(得分:3)

JAR的用户可以在使用JAR的Java项目的Java Build Path属性中将Javadoc位置(存档中的URL,文件或路径)与其关联。 我不确定这对Javadoc在同一个JAR中的效果与二进制文件(之前从未见过)有关,但从理论上说它应该可行。

答案 1 :(得分:1)

Apache Ant javadoc任务将生成API html。 通常,您会将其作为zip文件与您的罐子一起分发。

答案 2 :(得分:1)

您的构建过程是什么? Maven发布过程实际上生成了3个jar,其中一个包含已编译的类,一个包含源,另一个包含javadoc。您应该能够自定义POM以防止分发源jar,并且任何使用Maven来管理依赖项的人都会自动获取javadoc,如果它们声明了对jar的依赖(并且在eclipse maven插件中启用了javadoc下载)。

答案 3 :(得分:0)

Javadocs是源代码的一部分,因为任何编译的类都不包含任何注释 - Javadocs 注释。

换句话说,你不能。

答案 4 :(得分:0)

JIDE have a tool(价格25美元)将运行您的源代码并删除所有方法体,将javadoc保留在其中,并生成一个zip文件。然后,您可以将此zip文件作为源zip分发,并且您的IDE将能够读取javadoc,但当然您的所有逻辑都已删除,因此您可以保留您的闭源。 zip文件中不包含任何私有成员和方法。

它还具有保留intellisense方法参数名称的额外好处,因此以下方法

public void foo( String text, Integer index ) {
}
当你自动完成时,

将显示 foo(字符串文本,整数索引),而不是 foo(String arg1,Integer arg2),这样你就可以提示参数是什么应该是。

相关问题