hyperlink - Javadoc 标签 @link 与 Doxygen : unable to resolve link

Question

我使用 Javadoc 进行记录，并且非常欣赏与 Eclipse 的集成，但我想使用 Doxygen 来添加图表。

我在几个简短的描述中使用标签 {link foo} 来链接到标准 Java 类和我自己的类。

这是一个 SSCCE:

package org.foo.myproject;

import javax.swing.JList;

/**
 * This is a Javadoc line {@link JList}
 * 
 * @author theauthor
 * @version 1.0.0
 */
public class JavadocLinkFailedDemo {
}

我在使用 Doxygen (1.8.4) 时遇到以下错误:警告:无法解析\link 命令的 JList 链接(我使用用 doxygen.exe 生成的 doxyfile 模板，为 . java 源和特定的输入/输出目录)

这与question有类似的问题但主题作者的解决方案对我来说不起作用。

感谢您提前提供的帮助。

编辑1:我只是尝试用 doxygen 生成 Java API 来获取相应的标记文件。然后，我在这个演示项目中使用了这个文件，其中我使用一个参数作为 JList 添加了一个构造函数 => 仅针对该参数解析链接，从不使用链接命令解析链接。

编辑2:我终于成功保留了这种签名:{@link ...}。对于我的示例，如果满足以下条件，JList 就会被解析:
- 写入类文件的完全限定名称
- 使用doxygen生成jdk的文档，生成标签文件并在项目中使用该标签

最终的示例代码是:

package org.foo.myproject;

import javax.swing.JList;

/**
 * This is a Javadoc line with {@link javax.swing.JList}
 * 
 * @author theauthor
 * @version 1.0.0
 */
public class JavadocLinkFailedDemo {
    /**
     * This is a Javadoc line of the constructor with {@link javax.swing.JList}
     * 
     * @param aList
     *            The list
     */
    public JavadocLinkFailedDemo(JList aList) {
    }
}

最终结果:

但是，构建 .chm 帮助文件几乎是不可能的，因为完成此任务需要一段时间，并且您会得到一个非常大的文件。但这是另一个问题......

Answer 1

我还没有尝试过这个，但我相信您需要的是@link之前的转义字符。这应该看起来像 \@link 或 @@link，但我更喜欢 \@link。

现在我相信 doxygen 应该能够正确处理你的 javadoc 注释，但是我不确定这是否适用于 JavaDoc，或者 JavaDoc 现在是否在提示。另外，它在您的 doxygen 文档中可能看起来很奇怪，因为应该显示一个 @link JList}，...我想这也不完全是您想要的。