跨越多行的 Doxygen javadoc 样式标签描述

Question

在一个 C++ 项目中，我使用 doxygen 和 javadoc 样式来编写文档。我对 javadoc 还很陌生，不确定这种类型的东西是否有效。

/**
 * ...stuff...
 * @return foo foo foo foo foo. Foo foo
 * foo foo foo foo foo.
 */

即返回的信息（我的问题适用于所有标签）需要涵盖多行。这是自动检测到的还是我需要做一些特别的事情？

另外，据我了解，您可以有一个简短的类描述和更深入的类描述。像上面的问题一样，简短的类描述可以多于一行吗？如果是这样，它的语法是什么？

Answer 1

doxygen docs 声明

如果使用 {curly} 大括号 参数延伸到下一个 段落。段落由 一个空行或一个部分 指标。

return 命令被列为段落样式命令。因此，您可以使用任意数量的行，添加一个额外的空白行或只是启动一个新命令来结束 return。