代码之家  ›  专栏  ›  技术社区  ›  Tom

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

  •  1
  • Tom  · 技术社区  · 16 年前

    我正在构建jar,我想在那里打包它们而不使用源代码,但我希望javadoc能够在Eclipse中为开发人员提供支持。

    5 回复  |  直到 16 年前
        1
  •  1
  •   Jherico    16 年前

    您的构建过程是什么?Maven发布过程实际上生成了3个jar,一个包含编译类,一个包含源代码,另一个包含javadocs。您应该能够定制pom以防止源jar的分发,并且任何使用maven管理依赖项的人,如果声明了对您的jar的依赖性(并且在eclipse maven插件中打开了javadoc下载),将自动获得javadoc。

        2
  •  3
  •   Zsolt Török    16 年前

    JAR的用户可以将JavaDoc位置(归档文件中的URL、文件或路径)与Java项目的Java构建路径属性相关联,其中使用JAR。
    我不确定在与二进制文件相同的jar中使用javadoc有多好(以前从未见过),但理论上它应该可以工作。

        3
  •  1
  •   Ben Hammond    16 年前

    ApacheAntJavaDoc任务将生成API HTML。 通常情况下,您会将它作为一个压缩文件与JAR一起分发。

        4
  •  0
  •   Seb    16 年前

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

    换句话说,你不能。

        5
  •  0
  •   banjollity    16 年前

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

    它还增加了保留intellisense方法参数名称的额外功能,因此下面的方法

    public void foo( String text, Integer index ) {
    }
    

    将展示 foo(字符串文本,整数索引) 当您自动完成时,而不是 foo(字符串arg1,整数arg2) 所以您可以提示参数应该是什么。