我正在构建 jar,我想在没有源的情况下打包它们,但我希望 javadoc 在 eclipse 中为开发人员提供。
5 回答
JAR 的用户可以在使用 JAR 的 Java 项目的 Java 构建路径属性中将 Javadoc 位置(归档中的 URL、文件或路径)与它相关联。
我不确定这在与二进制文件相同的 JAR 中使用 Javadoc 的效果如何(以前从未见过),但理论上它应该可以工作。
Apache Ant javadoc 任务将生成 API html。通常,您会将其作为 zip 文件与您的 jar 一起分发。
你的构建过程是什么?Maven 发布过程实际上生成了 3 个 jar,一个包含已编译的类,一个包含源代码,一个包含 javadocs。您应该能够自定义 POM 以防止分发源 jar,并且任何使用 Maven 管理依赖项的人如果声明对您的 jar 的依赖项(并在 eclipse maven 插件中打开 javadoc 下载),将自动获取 javadoc。
Javadocs 是源代码的一部分,因为任何编译的类都不会包含任何注释——Javadocs是注释。
换句话说,你不能。
JIDE 有一个工具(售价 25 美元),它可以运行您的源代码并删除所有方法主体,留下 javadoc,并生成一个 zip 文件。然后,您可以将此 zip 作为源 zip 分发,并且您的 IDE 将能够读取 javadocs,但当然您的所有逻辑都已被删除,因此您可以保留您的封闭源代码。zip 文件中不包含任何私有成员和方法。
它还具有为智能感知保留方法参数名称的额外好处,因此以下方法
public void foo( String text, Integer index ) {
}
自动完成时将显示foo( String text, Integer index )而不是foo( String arg1, Integer arg2 ),因此您可以提示参数应该是什么。