java - 在 doxygen 中使用 @see 或 @link

Question

我之前使用 Javadoc 进行记录，并使用了标签 @see、@link 或 {@see foo} 和 {link foo} 在我的描述中链接到其他类。现在我尝试了doxygen，似乎这些标签不兼容。如果我运行 doxygen，完整的标签将被简单地解释为普通文本。

是否有任何替代标签可以用来获得相同的功能？

Answer 1

要链接到其他类，您应该使用 ref命令。您可以使用 \link 命令，但必须使用 \endlink 命令结束链接文本，我怀疑这是您的问题(尽管没有示例文档，我无法确保)。

摘自 automatic linking 上的 doxygen 手册部分，我建议您阅读，其中有一段关于类的链接:

All words in the documentation that correspond to a documented class and contain at least one non-lower case character will automatically be replaced by a link to the page containing the documentation of the class. If you want to prevent that a word that corresponds to a documented class is replaced by a link you should put a % in front of the word. To link to an all lower case symbol, use \ref.

需要考虑的一些进一步要点:

• Doxygen 确实接受 \see (与 \sa 同义)和 \link 命令。如果这些没有按预期工作，OP应该包含一些示例文档，我们可以尝试找出哪些没有按预期工作。

• 带有封闭的 { 和 } 的符号 {\command description} 在 doxygen 文档中并不常见，我'我不确定程序将如何处理这些，因此最好不要使用这种样式。