Doxygen Javadoc样式的标记描述跨越多行

lot*_*tad 5 documentation javadoc doxygen documentation-generation

在C ++项目中,我正在使用doxygen和javadoc样式进行文档编写。我对javadoc还是相当陌生,不确定这种事情是否有效。

/**
 * ...stuff...
 * @return foo foo foo foo foo. Foo foo
 * foo foo foo foo foo.
 */
Run Code Online (Sandbox Code Playgroud)

即返回的信息(我的问题适用于所有标签)需要涵盖多行。是否会自动检测到此信息,或者我需要做一些特别的事情?

另外,据我了解,您可以使用简短的类描述和更深入的类描述。像上面的问题一样,简短的类描述可以超过一行吗?如果是这样,其语法是什么?

Dav*_*low 4

doxygen文档指出

如果使用大括号,则参数将延伸到下一段。段落由空行或节指示符分隔。

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