首页 > 解决方案 > Javadoc 和 maven:当它指向另一个 jar 时,使类引用可点击

问题描述

我有两个罐子,一个用于接口,一个用于实现。例如在第一个罐子里我有:

package com.myapp.jar1
public inteface MyInterface {...}

在我的第二个罐子里

package com.myapp.jar2
import com.myapp.jar1.MyInterface

public class MyClass implements MyInterface {...}

当通过 maven 创建 javadocs 时,对同一包中的类的引用在链接中转换(如预期的那样),而对另一个包中的类的引用是简单文本。

我想问题是javadoc不知道MyInterface在哪里以及是谁。

是否存在通知 javadoc 签入其他包以获取 doc 的方法?

细节:

在 Apache 中,我有一个目录javadoc,我将所有的 jar 解压缩到那里:

/var/www/html/javadoc/jar1
/var/www/html/javadoc/jar2

所以我的链接将指向同一服务器中的另一个位置,或者如果是第三个生产的包(例如杰克逊),则指向外部资源

标签: javamavenjavadocmaven-javadoc-plugin

解决方案


以这种方式使用 javadoc 来查找其他包

{@link [<package>.]<class>[#<method>] label}
{@link [<package>.]<class>[#<method>]}
{@link #<method>}

例子:

{@link com.project.Interfaces.MyInterface MyInterface}

如果要显示完整路径,请不要使用标签。


Javadoc 在另一个.jar

  1. 右键单击项目:
  2. 构建路径 > 配置构建路径
  3. 库 > 选择库并展开它
  4. 选择“Javadoc 位置”> 单击右侧的“编辑”按钮。
  5. 使用文档添加您的 jar 文件
  6. 单击“验证”按钮以检查是否有任何问题

这个jar它是一个zip文件的重命名扩展,需要index.html在根目录中有一个。


参考:


推荐阅读