在doxygen中使用@see或@link [英] Use of @see or @link in doxygen

问题描述

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

I documented with Javadoc before and used the tags @see, @link or {@see foo} and {link foo} in my description to link to other classes. Now I tried doxygen and it seems that these tags are incompatible. If I run doxygen the complete tags are simply be interpreted as normal text.

我可以使用其他标签来获得相同的功能吗？

Are there any alternative tags which I can use to get the same features?

推荐答案

要链接到其他类，您应该使用 ref 命令。您可以使用 \ link 命令，但必须使用 \endlink 命令结束链接文本，该命令我怀疑是你的问题（虽然没有示例文档我无法确定）。

To link to other classes you should use the ref command. You can use the \link command, but you must end your link text with the \endlink command, which I suspect is your problem (although without example documentation I can't be sure).

来自自动链接，我建议你阅读，有关于课程链接的段落：

From the doxygen manual section on automatic linking, which I suggest you read, there is a paragraph on links to classes:

文档中与文档类对应且包含至少一个非小写字符的所有单词将自动替换为包含该类文档的页面的链接。如果您想要防止与文档类相对应的单词被链接替换，您应该在单词前放置一个％。要链接到全小写符号，请使用 \ ref 。

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应该包含一些示例文档，我们可以尝试并解决这个问题无法按预期工作。

• Doxygen does accept the \see (which is synonymous to \sa) and \link commands. If these are not working as expected the OP should include some example documentation you we can try and work out which this is not working as expected.

符号 {\命令说明} ，附上 {和} 在doxygen文档中不常见，我不确定该程序将如何处理这些因此最好不要使用这种风格。

The notation {\command description}, with the enclosing { and } is not common in doxygen documentation, I'm not sure how the program will treat these so it is probably best to not use this style.

这篇关于在doxygen中使用@see或@link的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！