在doxygen中使用@see或@link

Question

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

我可以使用任何替代标签来获得相同的功能吗？

Answer 1

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

我建议您阅读有关自动链接的doxygen手册部分，其中有一段有关类的链接：

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

需要考虑的其他几点：

• Doxygen确实接受和\see（是的同义词\sa）和\link命令。如果这些未按预期运行，则OP应包含一些示例文档，您可以尝试确定哪些未按预期运行。

• 在doxygen文档中，该符号{\command description}带有括起来{，}并不常见，我不确定该程序如何处理这些符号，因此最好不要使用此样式。