documentation - 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指出

If {curly} braces are used the argument extends until the next paragraph. Paragraphs are delimited by a blank line or by a section indicator.

return命令被列为段落样式的命令。因此，您可以根据需要使用任意多行，添加一个额外的空行或仅启动新命令以结束 return。