Javadoc 链接到其他类中的方法

java javadoc

2022-08-31 05:11:19

目前，我正在用这个Javadoc语法引用其他类中的方法：

@see {@link com.my.package.Class#method()}

根据我从文档中了解到的，这是执行此操作的正确方法。但现在到了有趣的部分，或者令人沮丧。当我生成这个javadoc时，我首先得到以下错误：

warning - Tag @see:illegal character: "123" in "{@link com.my.package.Class#method()}"
warning - Tag @see:illegal character: "64" in "{@link com.my.package.Class#method()}"
warning - Tag @see: reference not found: {@link com.my.package.Class#method()}

生成的 HTML 代码是：

"," <code>com.my.package.Class#method()}</code> ","

当然，我没有联系。谁能告诉我发生了什么，以及如何解决这个问题的任何提示？

根据 ASCII 表字符 123 和 64 for 将表示 { 和 @，那么为什么根据文档，当此语法正确时，这些字符无效呢？

答案 1

对于 Javadoc 标签，您不需要使用 ;Javadoc 将为您创建一个链接。尝试@see@link

@see com.my.package.Class#method()

以下是有关@see的详细信息。

答案 2

除此之外，引用另一个类的更一般的方式以及该类的可能方法是。这样做的好处是可以在javadoc描述的中间使用。@see{@link somepackage.SomeClass#someMethod(paramTypes)}

来自javadoc文档（@link标签的描述）：：

这个标签与@see非常相似 - 两者都需要相同的引用，并接受完全相同的语法用于package.class#member和label。主要区别在于 {@link} 生成内联链接，而不是将链接放在“另请参阅”部分中。此外，{@link} 标记以大括号开头和结尾，以将其与行内文本的其余部分分开。