我之前使用 Javadoc 进行了文档记录，并使用了 tags @see，@link或者在我的描述中链接到其他类。现在我尝试了 doxygen，似乎这些标签不兼容。如果我运行 doxygen，则完整的标签将被简单地解释为普通文本。{@see foo}{link foo}
我可以使用任何替代标签来获得相同的功能吗？
问问题
15446 次
3 回答
5
要链接到其他类，您应该使用该ref命令。您可以使用该\link命令，但您必须使用该命令结束链接文本\endlink，我怀疑这是您的问题（尽管没有示例文档，我无法确定）。
从我建议您阅读的关于自动链接的 doxygen 手册部分中，有一段关于类的链接：
文档中与文档类相对应且包含至少一个非小写字符的所有单词将自动替换为指向包含该类文档的页面的链接。如果您想防止与文档类相对应的单词被链接替换，您应该
%在单词前面放置一个。要链接到全小写符号，请使用\ref.
还有一些需要考虑的点：
Doxygen 确实接受
\see（与 同义\sa）和\link命令。如果这些没有按预期工作，则 OP 应该包含一些示例文档，我们可以尝试找出它没有按预期工作。{\command description}带有封闭符号的符号在 doxygen 文档{中}并不常见，我不确定程序将如何处理这些符号，因此最好不要使用这种样式。
于 2012-08-17T08:58:41.050 回答
1
我怀疑你在评论//
Doxygen 将以这种方式捕获标签：
/**
* @KEYWORD DESCRIPTION
*/
您也可以只添加三分之一/以使每个注释行都以 doxygen 开头，///因为 doxygen 也会捕捉到这一点。
于 2012-08-16T16:35:23.790 回答
0
我偶然发现了一篇不错的文章，它比较了 javadoc 和 doxygen，显示了一些示例等效代码（@link 等）。你可以在这里看到它。我希望它有所帮助。
于 2012-08-16T16:32:15.400 回答